Skip to content

sdlcforge/core-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

129 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sdlcforge cli

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

Install

  1. If either npm -v or node -v are not found, see 'Install node and npm'.
  2. Install 'sdlcpilot-cli' and 'comply-server'. (These package names will be updated shortly.)
    npm i -g sdlcpilot-cli comply-server
  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.

Install node and npm

We recommend using Node Version Manager (nvm) to install node and npm; nvm installation instructions can be found here. nvm provides support for installing 'global' packages on a per-user account basis without the need for root priveleges. It also provides a convenient tool for using and testing different versions of node.

To use the latest "long term support" version (LTS), use:

nvm install --lts
nvm use --lts

Or to use the latest stable version, use:

nvm install node
nvm use node

Usage

  1. Create a project:
    sdlc projects create -- newProjectName=liquid-labs/indepndent-context
    
    This will both create a (initially private) repo and check it out in your playground base, which is ${HOME}/playground. (This is not currently configurable.) -- or -- You can git clone a project under ~/playground. The standard expected layout is ~/playground/<git org>/<repo name>. (In future, sdlc will support importing projects directly.)
  2. Change dir to the new project: cd independent-context
  3. Open an "Initial implementation" issue and start the work. After this, you should be on the workbranch.
    1. Create the issue in GitHub if you want to be verbose. Then start the work:
      sdlc work start -- issues=1
      
    2. Directly from the command line:
      sdlc work start -- issueTitle='Initial implementation' issueOverview='Implement basic functions' issueDeliverables="do X;;do Y"
      
  4. Create a minimal project (TODO: I think this may be automated somewhere...):
    mkdkir src
    echo -e "console.log('Hello world!')\n" > src/index.mjs
    
  5. Setup development cycle stuff (if creating a Javascript based project):
    1. sdlc projects workflows local node-build add
    2. Update the package.json scripts:
      "scripts": {
          "build": "make build",
          "test": "make test",
          "preversion": "make qa",
          "lint": "make lint",
          "lint:fix": "make lint-fix",
          "qa": "make qa"
        }
      
  6. Do some work and save it: sdlc work save -- summary="initial implementation"
  7. Create PR: sdlc work submit
  8. Review and merge PR on GitHub.
  9. Close the work and return to main: sdlc work close

Refer to the user documentation

About

undefined

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors