Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.03 KB

DEVELOPERS.md

File metadata and controls

40 lines (27 loc) · 1.03 KB

developers

This document is for developers working on the runbook application itself. If you're interested in using runbook, see the README.

To run without building first, use:

npx ts-node src/cli.ts ls  # or any other runbook command

To quickly test while developing this package, run:

npx ts-node src/cli.ts run hello --greeting Hey --name Batman

Alternatively, the package can be linked and run with the DEV=true environment variable to pick up the latest TypeScript source changes without the need to re-link the package.

npm link
DEV=true runbook run hello --greeting Hey --name Batman

Here's some fun - using runbook to run runbook to run the raw TypeScript version of runbook to run the "hello" command.

runbook run runbook run hello

To run all test cases:

npm run test

Here is a command that always fails (useful for seeing how runbook handles errors):

exit 1