blacktide-cli

Blacktide CLI

Provides a set of cli tools to work with blacktide

Notes

Blacktide notes:

• No support for static content or sessions
• Built with Express, use it: blacktide.app
• When using Mongoose, use it: blacktide.db

Generators notes:

• All commands overwrite everything
• All commands are executed in the cwd
• Names used in the generators will remain as typed ;)
• Check mongoose for info about the database and models

Install

$ npm i -g blacktide-cli

Structure of the generated application:

• app_folder/services - holds all the services.
• app_folder/services/index.js - entry point for application services, holds the / route
• app_folder/models - if using mongoose
• app_folder/conf - holds all .json files for each environment
• app_folder/test - comes with very basic testing.
• app_folder/package.json - custom tailored for the application

Usage

Help

Long version

$ blacktide --help

Output:

$ blacktide --help

  Usage: blacktide [options] [command]


  Commands:

    help|h [what]             Shows general and command help
    generate|g <what> [name]  Generates something

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

------------------------------------------------

  Blacktide cli v1.0.0


  Blacktide notes:

    * No support for static content
    * Built with Express, use it: blacktide.app
    * When using Mongoose, use it: blacktide.db

  generate:

    $ blacktide generate app profiles
    $ blacktide generate service profile
    $ blacktide generate model profile
    $ blacktide generate conf development

Short version

$ blacktide help

Generate

$ blacktide help generate

Generators

$ blacktide generate app myapp

What it does:

• Creates an app, with all the folders, config, etc
• Ask questions about what do you want

$ blacktide generate service myservice

What it does:

• Creates a service inside the generated app structure
• If you have mongoose enabled it asks to generate a model

$ blacktide generate model mymodel

What it does:

• Creates a model inside the generated app structure
• Very simple, no questions ask

$ blacktide generate conf development

What it does:

• Creates or overwrites a conf inside the generated app structure
• Useful to "edit" the most basic stuff

Tests

No tests so far... Coming soon

License

MIT