DeepFlow CLI

Zero-dependency CLI wrapper for DeepFlow Web methods.

Install

npm install -g @metagptx/deepflow-cli
deepflow --help
deepflow -l -t <dfpat_token> --base-url https://deepflow.example.com

npx is still useful for one-off execution, but it does not install deepflow into your PATH for later shell sessions:

npx @metagptx/deepflow-cli --help
npx --package @metagptx/deepflow-cli deepflow --help

For local development from this repository:

npm link
deepflow --help
node bin/deepflow.js --help

Authenticate

deepflow -l -t <dfpat_token>

Equivalent forms:

deepflow -login -t <dfpat_token>
deepflow --login -t <dfpat_token>
deepflow auth login -t <dfpat_token>

Config is stored at:

~/.deepflow/config.json

Run Plan

deepflow plan run \
  --repo <repo_id_or_app_code> \
  --name "Demo Iteration" \
  --context "Plan this change" \
  --prompt "Create an implementation plan only." \
  --json

plan run --json returns statusUrl, messagesUrl, and stopUrl so external callers can poll or stop the created session without knowing DeepFlow Web route details.

Checks

npm run check
npm test
npm run smoke
npm run pack:dry-run

Run the full Web-backed smoke when a token and app are available:

DEEPFLOW_CLI_E2E_TOKEN=<dfpat_token> \
DEEPFLOW_CLI_E2E_BASE_URL=http://localhost:3100 \
npm run smoke:e2e

Useful environment variables:

export DEEPFLOW_BASE_URL=http://localhost:3100
export DEEPFLOW_TOKEN=dfpat_xxx

Publish

Validate the package contents before publishing:

npm run check
npm test
npm run smoke
npm run pack:dry-run

Publish to the configured npm registry:

npm publish --access public

For a private company registry, pass the registry explicitly:

npm publish --registry <registry-url>