BreatheCode-Cli

Command Line Interface for BreatheCode students:

• Download boilerplates.
• Cloud 9 integration.
• Automatic code generation (snippets).
• Syntact correction.
• Any idea? Suggest new features or integrations here.

Table of contents

• BreatheCode-Cli
• Install
• Usage
• Commands

Install

Make sure you have node 8+

$ node -v

With npm:

$ npm install -g breathecode-cli

OR with yarn:

$ yarn global add breathecode-cli

Usage

$ npm install -g breathecode-cli
$ breathecode COMMAND
running command...
$ breathecode (-v|--version|version)
breathecode-cli/1.1.52 linux-x64 node-v10.15.3
$ breathecode --help [COMMAND]
USAGE
  $ breathecode COMMAND
...

Commands

• breathecode app:all
• breathecode app:get-todos
• breathecode help [COMMAND]
• breathecode run:exercises
• breathecode run:server
• breathecode start:all
• breathecode start:django
• breathecode start:django-project
• breathecode start:exercises
• breathecode start:flux
• breathecode start:flux-project
• breathecode start:react
• breathecode start:react-exercises
• breathecode start:react-project
• breathecode start:react-webapp
• breathecode start:vanillajs
• breathecode start:vanillajs-project
• breathecode start:wordpress
• breathecode start:wordpress-project
• breathecode test:exercise

app:all

Small apps to help developers

USAGE
  $ breathecode app:all

See code: src/commands/app/all.js

app:get-todos

Reads your code looking for //TODO: comments

USAGE
  $ breathecode app:get-todos

OPTIONS
  -l, --log                              log scaned files on the console
  -t, --type=js|jsx|scss|css|md|html|py  [default: js] file extensions to look for

See code: src/commands/app/get-todos.js

help [COMMAND]

display help for breathecode

USAGE
  $ breathecode help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

run:exercises

Runs a small server with all the exercise instructions

USAGE
  $ breathecode run:exercises

OPTIONS
  -h, --host=host  [default: localhost] server host
  -o, --output     show build output on console
  -p, --port=port  [default: 8080] server port

See code: src/commands/run/exercises.js

run:server

Runs a dummy server without any configuration

USAGE
  $ breathecode run:server

OPTIONS
  -c, --compiler=compiler  compiler type: react, vanillajs, etc.
  -e, --entry=entry        entry file path for the server
  -h, --host=host          [default: localhost] server host
  -p, --port=port          [default: 8080] server port

See code: src/commands/run/server.js

start:all

A collection of boilerplates to start new projects

USAGE
  $ breathecode start:all

See code: src/commands/start/all.js

start:django

Start a new django project or exercise

USAGE
  $ breathecode start:django

See code: src/commands/start/django.js

start:django-project

Start a new Django+REST project

USAGE
  $ breathecode start:django-project

See code: src/commands/start/django-project.js

start:django-project

Start a new Django+REST project

USAGE
  $ breathecode start:django-project

See code: src/commands/start/django-project.js

start:exercises

Initialize the boilerplate for creating exercises

USAGE
  $ breathecode start:exercises

OPTIONS
  -c, --compiler=compiler  specify what compiler you want: [react, vanilajs]

See code: src/commands/start/exercises.js

start:flux

Start a new flux project or exercise

USAGE
  $ breathecode start:flux

See code: src/commands/start/flux.js

start:flux-project

Start a new React+Flux project

USAGE
  $ breathecode start:flux-project

OPTIONS
  -m, --mode=mode  install a particular branch or version for the boilerplate
  -n, --name=name  [default: hello-rigo] app name
  -r, --root       install on the root directory

See code: src/commands/start/flux-project.js

start:flux-project

Start a new React+Flux project

USAGE
  $ breathecode start:flux-project

OPTIONS
  -m, --mode=mode  install a particular branch or version for the boilerplate
  -n, --name=name  [default: hello-rigo] app name
  -r, --root       install on the root directory

See code: src/commands/start/flux-project.js

start:react

Start a new react project or exercise

USAGE
  $ breathecode start:react

See code: src/commands/start/react.js

start:react-exercises

Start a new react project

USAGE
  $ breathecode start:react-exercises

OPTIONS
  -m, --mode=mode  install a particular branch or version for the boilerplate
  -n, --name=name  [default: hello-rigo] app name
  -r, --root       install on the root directory

See code: src/commands/start/react-exercises.js

start:react-project

Start a new react project

USAGE
  $ breathecode start:react-project

OPTIONS
  -m, --mode=mode  install a particular branch or version for the boilerplate
  -n, --name=name  [default: hello-rigo] app name
  -r, --root       install on the root directory

See code: src/commands/start/react-project.js

start:react-webapp

Start a new react project

USAGE
  $ breathecode start:react-webapp

OPTIONS
  -m, --mode=mode  install a particular branch or version for the boilerplate
  -n, --name=name  [default: hello-rigo] app name
  -r, --root       install on the root directory

See code: src/commands/start/react-webapp.js

start:react-exercises

Start a new react project

USAGE
  $ breathecode start:react-exercises

OPTIONS
  -m, --mode=mode  install a particular branch or version for the boilerplate
  -n, --name=name  [default: hello-rigo] app name
  -r, --root       install on the root directory

See code: src/commands/start/react-exercises.js

start:react-project

Start a new react project

USAGE
  $ breathecode start:react-project

OPTIONS
  -m, --mode=mode  install a particular branch or version for the boilerplate
  -n, --name=name  [default: hello-rigo] app name
  -r, --root       install on the root directory

See code: src/commands/start/react-project.js

start:react-webapp

Start a new react project

USAGE
  $ breathecode start:react-webapp

OPTIONS
  -m, --mode=mode  install a particular branch or version for the boilerplate
  -n, --name=name  [default: hello-rigo] app name
  -r, --root       install on the root directory

See code: src/commands/start/react-webapp.js

start:vanillajs

Start a new vanillajs project or exercise

USAGE
  $ breathecode start:vanillajs

See code: src/commands/start/vanillajs.js

start:vanillajs-project

Start a new Vanilla.js project

USAGE
  $ breathecode start:vanillajs-project

OPTIONS
  -m, --mode=mode  install a particular branch or version for the boilerplate
  -n, --name=name  [default: hello-rigo] app name
  -r, --root       install on the root directory

See code: src/commands/start/vanillajs-project.js

start:vanillajs-project

Start a new Vanilla.js project

USAGE
  $ breathecode start:vanillajs-project

OPTIONS
  -m, --mode=mode  install a particular branch or version for the boilerplate
  -n, --name=name  [default: hello-rigo] app name
  -r, --root       install on the root directory

See code: src/commands/start/vanillajs-project.js

start:wordpress

Start a new wordpress project or exercise

USAGE
  $ breathecode start:wordpress

See code: src/commands/start/wordpress.js

start:wordpress-project

Start a new wordpress project

USAGE
  $ breathecode start:wordpress-project

OPTIONS
  -m, --mode=mode  install a particular branch or version for the boilerplate
  -n, --name=name  [default: hello-rigo] app name
  -r, --root       install on the root directory

See code: src/commands/start/wordpress-project.js

start:wordpress-project

Start a new wordpress project

USAGE
  $ breathecode start:wordpress-project

OPTIONS
  -m, --mode=mode  install a particular branch or version for the boilerplate
  -n, --name=name  [default: hello-rigo] app name
  -r, --root       install on the root directory

See code: src/commands/start/wordpress-project.js

test:exercise

Run a particular exercise in the browser

USAGE
  $ breathecode test:exercise

OPTIONS
  -n, --number=number  number of the exercise

See code: src/commands/test/exercise.js