Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 1.94 KB

README.md

File metadata and controls

51 lines (36 loc) · 1.94 KB
Raw

sdlcpilot-cli

Command line interface for SDLCPilot, a Software Development Life Cycle management tool. Currently support GitHub node projects.

Installation

  1. Ensure node and npm are installed (see 'node not found')
  2. Install 'sdlcpilot-cli'. 
    npm i -g sdlcpilot-cli
  3. Run: 
    sdlc --setup
  4. Open a new terminal window to pickup the SDLCPilot tab completion support, or type 'source .bashrc' or 'source .zshrc' on from your bash or zsh terminal respectively.
  5. Install the base SDLC plugins: 
    sdlc server plugins bundles add -- bundles=sdlcpilot-github-node

Troubleshooting the install

sdlc not found

check where your global NPM packages are installed with:

npm ls -g

The first line should tell you where the NPM lib direcotry is located. Verify that if you swap that out lib for bin, you can ls the sdlc executable. It might be something like: /opt/homebrew/bin or /Users/foo/.npm-global/bin. Now update your PATH to include the global NPM bin directory.

node not found

If node is not installed, refer to the node package install page (MacOS and Windows) for installation instructions for your particular platform / distribution.

If/once node is installed, add the installation directory to your PATH (if not already done). For instance, if installing on MacOS with Homebrew, you would add /opt/homebrew/bin to the PATH var.

Update your PATH

For bash or zsh, add the following lines to .bashrc or .zshrc respectively:

PATH=/path/to/bin/dir:$PATH
export PATH

Where /path/to/bin/dir is replaced with the path of the bin directory in question.

Usage

Refer to the user documentation.