devnup-cli

The official Devnup Command Line Interface and NodeJS Modules.

Full module documentation and references available at http://cli.devnup.com/.

Command Line Interface

The command line interface is a simple tool for accessing Devnup library and resources using a NodeJS global module. It is publicly available through NPM.

Installing using NPM:

$ npm install -g devnup-cli
$ devnup help

Commands:

• Version: Gets the library version.

  $ devnup version

• Login: Authenticate a Devnup user and store its token for accessing resources.

  $ devnup login <email> [-v | --verbose]

  Options:

  • verbose: Verbose logging mode

• Clone: Clone a Git project from Devnup Gitlab.

  $ devnup clone [<org>/]<name> [-v | --verbose] [-s | --ssh] [-h | --https]

  Params:

  • org (optional): The name of the organization in Devnup Gitlab. Default: 'devnup'.
  • name: The name of the project in Devnup Gitlab.

  Options:

  • verbose: Verbose logging mode
  • ssh: Clone using SSH
  • https: Clone using HTTPS

• Remote: Add a remote repository reference from Devnup Gitlab to your local git.

  $ devnup clone [<org>/]<name> [-v | --verbose] [-s | --ssh] [-h | --https]

  Params:

  • org (optional): The name of the organization in Devnup Gitlab. Default: 'devnup'.
  • name: The name of the project in Devnup Gitlab.

  Options:

  • verbose: Verbose logging mode
  • ssh: Add SSH url
  • https: Add HTTPS url

• Generate: Create a new project based on a Devnup Boilerplate use the generate command.

  $ devnup generate <type> <name> [-v | --verbose]

  Params:

  • name: The name of the new project, will be used as directory name. Default: 'boilerplate'.
  • type: The boilerplate type. Types available:
    • nodejs: Boilerplate for a new NodeJS API
    • snippet: Boilerplate for a new Angular Snippet

  Options:

  • verbose: Verbose logging mode

NodeJS Module

Installing using NPM:

$ npm install devnup-cli --save

var devnup = require('devnup-cli');
console.log(devnup.version());

Submodules:

• Email: Interface to the Devnup Email API. Module documentation

  devnup.email();

• Generate: Interface to the Devnup Generator and its Boilerplates. Module documentation

  devnup.generate();

• Manager: Interface to the Devnup Manager API. Module documentation

  devnup.manager();

• Social: Interface to the Devnup Social API. Module documentation

  devnup.social();

• WS: Interface to the Devnup WS APIs. Module documentation

  devnup.ws();