Skip to content

Start typing to search the documentation.

CLI

Last updated View as Markdown

Install @flue/cli as a development dependency, then invoke the flue executable through your package manager:

npm install --save-dev @flue/cli
npx flue dev

The CLI requires Node.js >=22.19.0. Cloudflare development and deployment also require wrangler as a development dependency.

The CLI follows the application lifecycle: initialize a target, develop against it locally, exercise agents and workflows, inspect workflow runs, and create the artifact you deploy. Each command page documents its complete arguments, options, output, and target-specific behavior.

Initialize and configure

Use flue init once to create a starter flue.config.ts for Node.js or Cloudflare:

npx flue init --target node

The configuration selects the normal runtime target and can set the project root and build output. CLI flags provide one-time overrides. See flue init, Configuration, and Project Layout for the available settings and source discovery conventions.

Develop locally

Use flue dev while authoring an application:

npx flue dev

Development mode builds the discovered application for its configured target, serves it locally, and rebuilds as source files change. Use it to exercise the same routes and runtime environment that callers use. Agents and workflows are not public merely because they are built; Routing explains how to expose them and add application-owned routes.

Keep local credentials and platform values in environment configuration rather than source. See flue dev for watch behavior, ports, environment files, and target-specific details.

Exercise agents and workflows

For a Node.js target, the CLI can exercise discovered agents and workflows without public HTTP routes.

Use flue connect for an interactive connection to one continuing agent instance:

npx flue connect support-assistant ticket-8472

Use flue run for one finite workflow invocation:

npx flue run summarize-ticket --payload '{"ticket":"Ticket details"}'

These commands use private local execution and do not pass through application ingress middleware. Deployed applications instead receive input through their published routes and transports. See flue connect and flue run for their exact contracts.

Inspect workflow runs

Use flue logs to replay or follow events for a workflow run owned by a running Flue server:

npx flue logs run_01JX...

Runs are workflow-only. Direct agent prompts and dispatched agent inputs are persistent session interactions, not runs. A one-shot flue run process streams its own events and cannot be inspected later with flue logs. See flue logs for server selection, authentication headers, filtering, and output formats.

Build and deploy

Use flue build to create target-specific deployment output:

npx flue build

A build packages the discovered application for its runtime target. It does not choose a model, add credentials, expose additional routes, or configure platform-owned bindings. See flue build for output details, then continue to the Node.js or Cloudflare deployment guide.

Command reference

CommandDescription
flue initCreate an initial flue.config.ts.
flue devStart a watch-mode local development server.
flue connectOpen an interactive local agent-instance connection.
flue runExecute one workflow invocation locally.
flue logsReplay or follow workflow-run events from a running server.
flue buildCreate deployable application artifacts.
flue addFetch sandbox, channel, or database installation blueprints for a coding agent.
flue updateFetch a current blueprint so a coding agent can apply its newer upgrade guides.
flue docsList, read, and search the bundled Flue documentation.