@fdekit/cli

Purpose

@fdekit/cli is the npm package for the fdekit command-line interface. It scaffolds projects, installs and captures recipes, adds providers/connectors/policies/evals, validates configs, runs agents, manages approvals, exports feedback, runs evals, renders reports, opens traces, generates the console, and manages local runtime environments.

Use the CLI when you want the standard workflow from a terminal. Use @fdekit/runtime when you need to script the same behavior inside another Node process.

npm Package

Package page: @fdekit/cli

Install the CLI once for your shell:

npm install -g @fdekit/cli

The package installs the fdekit binary, so commands stay unscoped:

fdekit init
cd fdekit
fdekit recipe install support-triage
npm install

Scaffolded deployment projects also keep @fdekit/cli in devDependencies so npm scripts use a pinned project version. A local-only install exposes fdekit inside npm run and at ./node_modules/.bin/fdekit; it does not put fdekit on your shell PATH.

Bare fdekit init creates ./fdekit. Commands can run from there or from the containing customer project; config, package/env edits, recipes, and the artifacts/ directory stay inside the contained project.

Who should use this package

• Deployment authors starting or operating an FDEKit project.
• Forward-deployed engineers running validation, demos, evals, approvals, reports, and console output.
• Contributors adding or changing command behavior.

Choose @fdekit/core for config authoring helpers and @fdekit/runtime for programmatic execution.

5-minute quick example

From the repository root, the launch demo is:

npm install
npm run demo

For an installed project, the CLI primitives look like:

mkdir support-demo
cd support-demo
npm install -g @fdekit/cli@latest
fdekit init
cd fdekit
fdekit recipe install support-triage
npm install
npm run demo

The installed support-triage recipe starts the local customer API on 127.0.0.1:8787, waits for /health, runs the governed loop, generates the console, captures support-renewal-risk, and shuts the API down.

To step through the same loop manually:

npm run api

In another terminal:

npm run fdekit:doctor
npm run fdekit:validate
npm run fdekit:run
npm run fdekit:eval
npm run fdekit:console

Open artifacts/console.html after the console command to inspect traces, eval status, approvals, policy posture, reports, and exports.

Public API surface

The public surface is the fdekit binary, not a stable TypeScript import API:

fdekit init
fdekit recipe install support-triage
fdekit validate --strict
fdekit run supportTriage --strict
fdekit console

The CLI command reference documents the command surface and where each command is implemented: CLI API Reference.

Stability/backward-compat notes

@fdekit/cli is public but pre-1.0. Command names, documented flags, and scaffolded project structure are the compatibility boundary. Internal command modules are implementation details even though the CLI API reference links them for contributors.

See also

• Authoring contracts: @fdekit/core
• Runtime APIs used by commands: @fdekit/runtime
• Dashboard renderer used by fdekit console: @fdekit/console
• Full command reference: CLI Reference
• Recipe catalog: Recipes
• Local environments: Local Environment Cookbook