GitHubHelp

emily-v/breathecode-cli

Command Line Interface for BreatheCode Students

★ 0Forks 0JavaScriptGitHub ↗Compare

README

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.31 linux-x64 node-v8.11.4
$ breathecode --help [COMMAND]
USAGE
  $ breathecode COMMAND
...

Commands

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

c9:all

Interact with Cloud9 functionalities

USAGE
  $ breathecode c9:all

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

c9:mysql

Interact with MySQL

USAGE
  $ breathecode c9:mysql

OPTIONS
  --install  install MySQL
  --start    start MySQL
  --stop     stop MySQL

See code: src/commands/c9/mysql.js

c9:node

Interact node.js

USAGE
  $ breathecode c9:node

OPTIONS
  --upgrade  upgrade node to v8

See code: src/commands/c9/node.js

c9:phpmyadmin

Interact with PhpMyAdmin

USAGE
  $ breathecode c9:phpmyadmin

OPTIONS
  --install  install phpmyadmin

See code: src/commands/c9/phpmyadmin.js

generate:all

Generate template code and other boring stuff!

USAGE
  $ breathecode generate:all

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

generate:flux-action

Generate a new Flux.Action

USAGE
  $ breathecode generate:flux-action

OPTIONS
  -n, --name=name  the action name (optional)

See code: src/commands/generate/flux-action.js

generate:flux-folders

Generate Flux standard directories

USAGE
  $ breathecode generate:flux-folders

OPTIONS
  -w, --withSamples  include a sample Action, View and Store

See code: src/commands/generate/flux-folders.js

generate:flux-store

Generate a new flux store

USAGE
  $ breathecode generate:flux-store

OPTIONS
  -n, --name=name  the store name (optional)

See code: src/commands/generate/flux-store.js

generate:flux-view

Generate a new Flux.View

USAGE
  $ breathecode generate:flux-view

OPTIONS
  -n, --name=name  the view name (optional)

See code: src/commands/generate/flux-view.js

generate:react-component

Generate a new React.Component

USAGE
  $ breathecode generate:react-component

OPTIONS
  -n, --name=name  the component name (optional)

See code: src/commands/generate/react-component.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: 0.0.0.0] server host
  -o, --output     show build output on console
  -p, --port=port  [default: 8080] server port

See code: bc-exercise-cli

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: 0.0.0.0] server host
  -p, --port=port          [default: 8080] server port

See code: bc-exercise-cli

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: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: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: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: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

test:exercise

Run a particular exercise in the browser

USAGE
  $ breathecode test:exercise

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

See code: bc-exercise-cli

Contributors

alesanchezremily-vpandahacker

Issues