Giter VIP home page Giter VIP logo

breathecode-cli's Introduction

Version Build Status Downloads/week License

BreatheCode-Cli

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

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

Commands

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

breathecode-cli's People

Contributors

alesanchezr avatar dependabot[bot] avatar emily-v avatar pandahacker avatar plucodev avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

breathecode-cli's Issues

Starting new project with -r when files are present

One of the issues we have experienced relates to beginning a project when files are already present in the workspace.

As a feature request, it may be better to add in a functionality that checks if there are other files present in the workspace when using the "-r" flag to install.

If files are present, prompt the user and ask if they want to delete the files before installing. Then if they say yes, the CLI would empty all files and directories recursively, before beginning the install.

Spoke with @alesanchezr and he recommended posting on issue board.

Issue with local install

Node version: 11.0.0

Upon running start:react-project, got the following output:

bc start:react-project
(node:38644) Warning: Mismatched version in bc-exercise-cli plugin manifest. Expected: 0.7.6 Received: 0.7.06
This usually means you have an oclif.manifest.json file that should be deleted in development. This file should be automatically generated when publishing.
Error: The module '/usr/local/lib/node_modules/breathecode-cli/node_modules/sleep/build/Release/node_sleep.node'
was compiled against a different Node.js version using
NODE_MODULE_VERSION 48. This version of Node.js requires
NODE_MODULE_VERSION 67. Please try re-compiling or re-installing
the module (for instance, using `npm rebuild` or `npm install`).
    at Object.<anonymous> (/usr/local/lib/node_modules/breathecode-cli/node_modules/sleep/index.js:1:75)

Issue when trying to run start:react-webapp

Attempting to run the new boiler on local (just installed the cli)

bc start:react-webapp

(node:38609) Warning: Mismatched version in bc-exercise-cli plugin manifest. Expected: 0.7.6 Received: 0.7.06
This usually means you have an oclif.manifest.json file that should be deleted in development. This file should be automatically generated when publishing.
 ›   Error: command start:react-webapp not found

.js)_

breathecode-cli/README.md

Lines 215 to 216 in 46e7e7e

_See code: [src/commands/utils/todo.js](https://github.com/breatheco-de/breathecode-cli/blob/v1.1.92/src/commands/utils/todo.js)_
<!-- commandsstop -->


This issue was generated by todo based on a todo comment in 46e7e7e. It's been assigned to @alesanchezr because they committed the code.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.