BreatheCode-Cli

Command Line Interface for improving your coding skills, as a part of the BreatheCo.de platform.

• Hundreds of exercises on Javascript, Node, Python, Java, Webpack, etc.
• Hudreds of projects, with interactive video tutorials.
• Gitpod Integration for on click coding environment.
• 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.2.72 linux-x64 node-v10.15.3
$ breathecode --help [COMMAND]
USAGE
  $ breathecode COMMAND
...

Commands

• breathecode download:exercises
• breathecode download:template
• breathecode help [COMMAND]
• breathecode init
• breathecode login
• breathecode publish
• breathecode run
• breathecode update [CHANNEL]
• breathecode utils:todo

download:exercises

Download new exercises to practice a particular technology

USAGE
  $ breathecode download:exercises

OPTIONS
  -m, --mode=mode              install a particular branch or version for the boilerplate
  -n, --name=name              [default: hello-rigo] app folder name
  -r, --root                   install on the root directory
  -t, --technology=technology  technology, e.g: [dom,html,css,react,python-lists,python-beginner,etc].

ALIASES
  $ breathecode download:exercises

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

download:template

Download a new template or boilerplate

USAGE
  $ breathecode download:template

OPTIONS
  -m, --mode=mode              install a particular branch or version for the boilerplate
  -n, --name=name              [default: hello-rigo] app folder name
  -r, --root                   install on the root directory
  -t, --technology=technology  technology, e.g: [flask,django,react,flux,vanillajs,wordpress,etc].

ALIASES
  $ breathecode download:template

See code: src/commands/download/template.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

init

Create new exercises or tutorials

USAGE
  $ breathecode init

OPTIONS
  -g, --grading=grading    Grading type for exercises: [isolated, incremental]
  -l, --language=language  specify what language you want: [html, css, react, vanilajs, node, python]

See code: src/commands/init.js

login

Login to breathecode

USAGE
  $ breathecode login

OPTIONS
  -d, --debug                            debugger mode fro more verbage
  -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/login.js

publish

Publish project to the registry

USAGE
  $ breathecode publish

See code: src/commands/publish.js

run

Runs a small server with all the exercise instructions

USAGE
  $ breathecode run

OPTIONS
  -c, --create_mode                   start the exercises on create mode (for teachers)
  -d, --debug                         debugger mode for more verbage
  -d, --disable_grading               disble grading functionality
  -e, --editor=standalone|gitpod      [standalone, gitpod]
  -g, --grading=isolated|incremental  [isolated, incremental]
  -h, --host=host                     server host
  -l, --language=language             specify what language you want: [html, css, react, vanilajs, node, python]
  -p, --port=port                     server port

See code: src/commands/run.js

update [CHANNEL]

update the breathecode CLI

USAGE
  $ breathecode update [CHANNEL]

See code: @oclif/plugin-update

utils:todo

Reads your code looking for //TODO: comments

USAGE
  $ breathecode utils:todo

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/utils/todo.js