@alexjeffcott/amboss-pipeline-analyser

amboss-pipeline-analyser

Usage no npm install needed!

<script type="module">
  import alexjeffcottAmbossPipelineAnalyser from 'https://cdn.skypack.dev/@alexjeffcott/amboss-pipeline-analyser';
</script>

README

amboss-pipeline-analyser

=======================

example multi-command CLI built with typescript

Version CircleCI Codecov Downloads/week License

Working from the template github repo

Generate a repo from the template

Go to the template repo and create the new repo with the name of your project. Then clone the repo on your machine as usual.

git clone GH_CLONE_STRING
cd PROJECT_NAME

Give it a name

After cloning the repo global search and replace typescript-cli-template with your project name. Also do this with the command that you will want users to use for your application by global search and replacing typescriptclitemplate with your desired command. Please ensure that these changes have taken place everywhere including hidden directories. You may want to completely remove things like the .idea folder, for example.

Set the version

Ensure the version in package.json is 1.0.0 as a starting point. Subsequent versions should be bumped using the appropriate npm scripts.

Make it a github repo

See here.

Here this can be found as AlexJeffcott/amboss-pipeline-analyser

Set up codecov.io

See here.

This is very easy to set up - just create an account, or login, link the repo and copy the token.

Put it in CI/CD

See here.

This project uses circleci. This is very easy to set up - just create an account, or login, link the repo and tell it to use the config that already exists. Go to project settings/Environment Variables and add CODECOV_TOKEN with the token gleaned from codecov.io above.

Make it an npm package

Here this can be found as @alexjeffcott/amboss-pipeline-analyser NB this must be unique in npm registry, otherwise you will get confusing/misleading error messages.

Sign in to npm and publish

You must have an npm account, and the user must be able to create/publish packages.

Usage

$ npm install -g @alexjeffcott/amboss-pipeline-analyser
$ analyse-pipeline COMMAND
running command...
$ analyse-pipeline (-v|--version|version)
@alexjeffcott/amboss-pipeline-analyser/1.0.3 darwin-x64 node-v12.18.3
$ analyse-pipeline --help [COMMAND]
USAGE
  $ analyse-pipeline COMMAND
...

Commands

analyse-pipeline goodbye [FILE]

describe the command here

USAGE
  $ analyse-pipeline goodbye [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/goodbye.ts

analyse-pipeline hello [FILE]

describe the command here

USAGE
  $ analyse-pipeline hello [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

EXAMPLE
  $
  hello world from ./src/hello.ts!

See code: src/commands/hello.ts

analyse-pipeline help [COMMAND]

display help for analyse-pipeline

USAGE
  $ analyse-pipeline help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help