Skip to content

NPM Package

Use the npm package when you are writing and versioning flows in a project.

Install the package and, when you want editor feedback and the CLI typecheck preflight, TypeScript:

Terminal window
npm i @twelvehart/orcats
npm i -D typescript
bunx -p @twelvehart/orcats orcats --version

Bun >=1.3.0 must be on PATH; the npm package’s orcats binary is a Bun shim.

Flow files import from the public package surface:

import { flow, flowArgs, llm, selectBackend } from "@twelvehart/orcats";

Run a flow with:

Terminal window
bunx -p @twelvehart/orcats orcats --backend codex .orca/workflows/my-flow.ts -- "task input"

Read task input through flowArgs():

import { flowArgs } from "@twelvehart/orcats";
const args = flowArgs();

Do not read task input from process.argv; the CLI also uses argv for the flow path and flags.

Use the standalone binary only when you need an orcats executable that can run without a local node_modules install.