@jib/jib
Options
All
  • Public
  • Public/Protected
  • All
Menu

Quickstart jib CLI

The jib CLI for building @jib/cli projects.

npm version wercker status codecov GitHub license

Usage

This project may be installed globally, or used with npx. For the purposes of simplicity, the resulting CLI will be referenced as jib

npx @jib/jib
# or install globally
npm install -g @jib/jib

Starting New Projects

The jib init command is the quickest way to get started with a @jib/cli project.

jib init --help

Adding More Commands

Once a project is created, more commands can be added using jib add command.

jib add command --help

TODOs

  • Deep level command augmentation jib add command [name] [path]
  • Automatically link the installed CLI npm link
  • Add plugin generator jib plugin
  • Include unit testing scaffolding
  • Allow choice of CI (currently wercker)

Index

Classes

Interfaces

Functions

Object literals

Functions

classCase

  • classCase(str: string): string

Object literals

Const CONST

CONST: object

COMMAND_OUTDIR

COMMAND_OUTDIR: string = "build/commands"

COMMAND_ROOT

COMMAND_ROOT: string = "root"

COMMAND_SRCDIR

COMMAND_SRCDIR: string = "src/commands"

CORE_DEPS

CORE_DEPS: string[] = ['@jib/cli']

CORE_DEVDEPS

CORE_DEVDEPS: string[] = ['@jib/tslint', '@types/node', 'typescript', 'tslint', 'ts-node']

Const STRINGS

STRINGS: object

ERR_BIN_REQUIRED

ERR_BIN_REQUIRED: string = "A cli name is required"

ERR_COMMAND_REQUIRED

ERR_COMMAND_REQUIRED: string = "A command name is required"

ERR_PROJECT_REQUIRED

ERR_PROJECT_REQUIRED: string = "A project name is required"

PMT_BIN_NAME

PMT_BIN_NAME: string = "CLI bin name?"

PMT_CLI_TYPE

PMT_CLI_TYPE: string = "CLI type?"

PMT_COMMAND_NAME

PMT_COMMAND_NAME: string = "Command name?"

PMT_NOTEMPTY_MKDIR

PMT_NOTEMPTY_MKDIR: string = "Folder is not empty, would you like to make a new directory?"

PMT_PROJECT_NAME

PMT_PROJECT_NAME: string = "Package name?"