Skip to content
Command Line Interface for BreatheCode Students
JavaScript Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin finally fix the errors on bin executable Jul 18, 2019
docs
src testing the new grading mode for interactive tutorials Sep 23, 2019
test scan your code for todos Mar 22, 2018
.editorconfig first version of the breathecode-cli Mar 22, 2018
.eslintignore unit testing and eslinter Mar 22, 2018
.eslintrc
.gitattributes
.gitignore
.travis.yml
CHANGELOG.md
README.md
appveyor.yml
package-lock.json
package.json
yarn.lock

README.md

Version Build Status Downloads/week License

BreatheCode-Cli

Command Line Interface for BreatheCode students:

Table of contents

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.82 linux-x64 node-v10.15.3
$ breathecode --help [COMMAND]
USAGE
  $ breathecode COMMAND
...

Commands

create:exercises

Initialize the boilerplate for creating exercises

USAGE
  $ breathecode create:exercises

OPTIONS
  -l, --language=language  specify what language you want: [html, css, react, vanilajs, node, python]

See code: src/commands/create/exercises.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

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

run:exercises

Runs a small server with all the exercise instructions

USAGE
  $ breathecode run:exercises

OPTIONS
  -d, --debug                     debugger mode fro more verbage
  -e, --editor=standalone|gitpod  [default: standalone] [standalone, gitpod]
  -h, --host=host                 server host
  -l, --language=language         specify what language you want: [html, css, react, vanilajs, node, python]
  -m, --mode=exercises|tutorial   [default: exercises] [exercises, tutorial]
  -p, --port=port                 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:exercises

Start a new project using a boilerplate

USAGE
  $ breathecode start: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].

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

start:project

Start a new project using a boilerplate

USAGE
  $ breathecode start:project

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].

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

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

You can’t perform that action at this time.