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
Install
Make sure you have node 8+
$ node -v
The install with yarn:
$ yarn global add @breathecode/breathecode-cli
or with npm:
$ npm install -g @breathecode/breathecode-cli
Usage
$ npm install -g @breathecode/breathecode-cli
$ breathecode COMMAND
running command...
$ breathecode (-v|--version|version)
@breathecode/breathecode-cli/1.0.2 linux-x64 node-v8.11.3
$ breathecode --help [COMMAND]
USAGE
$ breathecode COMMAND
...
Commands
- breathecode c9:all
- breathecode c9:mysql
- breathecode c9:node
- breathecode c9:phpmyadmin
- breathecode code:all
- breathecode code:get-todos
- breathecode generate:all
- breathecode generate:flux-action
- breathecode generate:flux-folders
- breathecode generate:flux-store
- breathecode generate:flux-view
- breathecode generate:react-component
- breathecode help [COMMAND]
- breathecode start:all
- breathecode start:django-rest
- breathecode start:flux
- breathecode start:react
- breathecode start:vanillajs
- breathecode start:wordpress
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
code:all
Analyze your code for best practices and find TODOs
USAGE
$ breathecode code:all
See code: src/commands/code/all.js
code:get-todos
Reads your code looking for //TODO: comments
USAGE
$ breathecode code: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/code/get-todos.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
start:all
A collection of boilerplates to start new projects
USAGE
$ breathecode start:all
See code: src/commands/start/all.js
start:django-rest
Start a new Django+REST project
USAGE
$ breathecode start:django-rest
See code: src/commands/start/django-rest.js
start:flux
Start a new React+Flux project
USAGE
$ breathecode start:flux
OPTIONS
-b, --branch=branch install a particular branch or version
-n, --name=name [default: hello-rigo] app name
-r, --root install on the root directory
See code: src/commands/start/flux.js
start:react
Start a new react project
USAGE
$ breathecode start:react
OPTIONS
-b, --branch=branch install a particular branch or version
-n, --name=name [default: hello-rigo] app name
-r, --root install on the root directory
See code: src/commands/start/react.js
start:vanillajs
Start a new Vanilla.js project
USAGE
$ breathecode start:vanillajs
OPTIONS
-b, --branch=branch install a particular branch or version
-n, --name=name [default: hello-rigo] app name
-r, --root install on the root directory
See code: src/commands/start/vanillajs.js
start:wordpress
Start a new react project
USAGE
$ breathecode start:wordpress
OPTIONS
-b, --branch=branch install a particular branch or version
-n, --name=name [default: hello-rigo] app name
-r, --root install on the root directory
See code: src/commands/start/wordpress.js