@pota/cli ·

Create, extend and run CLI applications.

Install

npm install @pota/cli

Usage

If your project already has local commands or a scripts package setup. You can call those commands with the pota binary:

npx pota <insert-command>

unsure what commands are available?

run pota with the --help argument to see the loaded commands

npx pota --help

unsure what options are available for command <insert-command> ?

run pota <insert-command> with the --help argument to see available options for the command

npx pota <insert-command> --help

If your project does not have local commands or a scripts package setup. You can use one of the official scripts packages or define your own commands locally.

example using @pota/webpack-scripts

@pota/cli needs to to know where it can find its commands, this can be done by setting the pota key in your project's package.json:

npm pkg set pota="@pota/webpack-scripts"

example package.json

{
  "name": "pota-project",
  "pota": "@pota/webpack-scripts"
}

Documentation

• Authoring Commands
• Extending Commands
• Using Dependencies

Tips

• The pota field in package.json supports arrays; you can define multiple command sources:

npm pkg set pota[0]="@pota/webpack-scripts" pota[1]="other-scripts"

Contributing

See CONTRIBUTING.md

License

Pota is MIT licensed.