Setup

Install the Epismo CLI and learn its JSON input, output, and exit codes.


Start here the first time you install the CLI. Once it is set up, move on to Authentication to sign in.

Install

npm install -g epismo
epismo --help

The CLI requires Node.js 18 or newer. It runs a quiet update check about once a day; set EPISMO_UPDATE_CHECK=0 to turn that off (useful in CI). Every command supports --help, and so does every subcommand, e.g. epismo pack create --help.

JSON input

Commands that take structured data accept it three ways. You can pass inline JSON, a file with @, or stdin with -:

epismo pack create --input '{"type":"context","title":"Runbook","scope":{"type":"personal"}}'
epismo pack create --input @pack.json
cat pack.json | epismo pack create --input -

Explicit flags override fields loaded from --input, so you can keep a shared template in your repository and change only what differs per run:

epismo track create --input @task.json --title "Override title"

Output and exit codes

The CLI is built to be scripted:

  • Results are printed to stdout as JSON. Pipe them straight into tools like jq.
  • Warnings and errors go to stderr, so they never corrupt the JSON on stdout.
  • The CLI exits 0 on success and a non-zero code on failure, so if epismo …; then and CI steps detect failures reliably.
# Capture clean JSON while letting errors surface separately
pack=$(epismo pack get @team-onboarding) || echo "lookup failed" >&2
echo "$pack" | jq '.title'