Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/withastro/flue/llms.txt

Use this file to discover all available pages before exploring further.

The flue binary is the single entry point for everything in the Flue development lifecycle. It ships as part of @flue/cli and is available as npx flue or just flue if installed globally. 
npx flue <command> [flags]
# or, if installed globally:
flue <command> [flags]

​
Commands

flue dev

Long-running watch-mode dev server. Rebuilds and reloads on file changes.

flue run

One-shot build and agent invocation. Perfect for CI and scripted runs.

flue build

Produce a deployable artifact in ./dist without running the agent.

flue init

Scaffold a starter flue.config.ts in the target directory.

flue add

Fetch and install a sandbox connector via your AI coding agent.

flue logs

Stream or replay structured run events from a running Flue server.

​
Global flags

These flags are accepted by dev, run, and build. CLI flags always override values set in flue.config.*.
FlagDescription
--root <path>Project root. Defaults to the current working directory. Source files (agents/, roles/) live at <root>/.flue/ if that directory exists, otherwise at <root>/ directly.
--output <path>Where build artifacts are written. Default: <root>/dist.
--config <path>Path to a flue.config.{ts,mts,mjs,js,cjs,cts} file (relative to cwd). Default: auto-discover from the root directory.
--target <node|cloudflare>Build target. Required if not set in flue.config.*.

​
Default port

The dev server listens on port 3583 by default — “FLUE” on a phone keypad. Override with --port.

​
Configuration file

Any command that accepts --config can also pick up settings from a flue.config.ts (or .mts, .mjs, .js, .cjs, .cts) file at the project root. The config file sets target, root, and output; CLI flags always take precedence. 
// flue.config.ts
import { defineConfig } from '@flue/cli/config';

export default defineConfig({
  target: 'node',
});

Build docs developers (and LLMs) love

Get started for freeTalk to us