Documentation
¶
Overview ¶
Command flow is the Flowstate CLI: it validates, fixes, tests, and runs Flowfiles locally, and serves as the control plane, worker, and operator tooling for durable execution against Temporal. Run `flow --help` for the command tree; docs/reference/ is generated from it.
One rule spans every renderer's colors, and a new output surface inherits it on purpose rather than by imitation: yellow (Warning) marks a fact worth reading that is not a verdict — a coverage gap without `--coverage-required`, an unused stub without `--fail-on-warning`, a "nothing was explored" honesty line — and red (Danger) marks exactly what decides an exit code. A fact promoted to the exit code by a flag changes color with the flag, because the color is the claim.
Source Files
¶
- acme.go
- acme_cache_unix.go
- audit.go
- auditwiring.go
- authcheck.go
- authwhoami.go
- breaking.go
- breaking_modules.go
- breaking_records.go
- client.go
- clientcert.go
- codec.go
- codeccmd.go
- codecserve.go
- compile.go
- credentials.go
- dap.go
- debugconsole.go
- debugpanes.go
- debugrecord.go
- debugremote.go
- debugreplay.go
- debugscreen.go
- debugsource.go
- debugtui.go
- diagnostics.go
- docs.go
- egress.go
- execpolicy.go
- execute.go
- explore.go
- fix.go
- fixstale.go
- fmtcmd.go
- gatesui.go
- get.go
- graph.go
- help.go
- identitysigner.go
- init.go
- inputs.go
- internallistener.go
- jwt.go
- keys.go
- lifecycle.go
- lint.go
- login.go
- main.go
- mcp.go
- mcpcheckpolicy.go
- mcpdebug.go
- mcpdebugsession.go
- mcpserve.go
- mtls.go
- output.go
- plugincatalog.go
- pluginpins.go
- plugins.go
- policytest.go
- protectedresource.go
- readbounded.go
- renamedflags.go
- routing.go
- rpcoptions.go
- rpcresource.go
- runlocal.go
- runlocalreverse.go
- runlog.go
- schedule.go
- secrets.go
- sensitive.go
- serverdev.go
- serverdev_auth.go
- signals.go
- signalscheck.go
- stdiobanner.go
- stubbedlaunch.go
- suggest.go
- taskpolicy.go
- taskrun.go
- tasks.go
- telemetry.go
- tenant.go
- tenantkeys.go
- test.go
- test_junit.go
- test_watch.go
- testdebug.go
- testdebugreversible.go
- timeline.go
- tls.go
- validateclaims.go
- validatespec.go
- validatewalk.go
- venue.go
- version.go
- watch.go
- webhooks.go
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
appearance
Package appearance holds the CLI's appearance pins: charmbracelet/vhs tape files under testdata, one per styled surface, each paired with a golden of the terminal screen the tape produces.
|
Package appearance holds the CLI's appearance pins: charmbracelet/vhs tape files under testdata, one per styled surface, each paired with a golden of the terminal screen the tape produces. |
|
debugpane
Package debugpane draws the debugger's two panes — where the run is, and what it can name — from a paused session's own read-only surface (#928 slice 1, #1111 item 2).
|
Package debugpane draws the debugger's two panes — where the run is, and what it can name — from a paused session's own read-only surface (#928 slice 1, #1111 item 2). |
|
debugtui
Package debugtui is the debugger's full-screen view: a bubbletea screen over one flowdebug.Target, opened by `flow debug attach --tui`.
|
Package debugtui is the debugger's full-screen view: a bubbletea screen over one flowdebug.Target, opened by `flow debug attach --tui`. |
|
docsgen
Package docsgen generates the reference documentation under docs/reference/, from the things that cannot drift.
|
Package docsgen generates the reference documentation under docs/reference/, from the things that cannot drift. |
|
exploretui
Package exploretui is the full-screen system explorer: `flow explore`.
|
Package exploretui is the full-screen system explorer: `flow explore`. |
|
fragments
Package fragments holds the interactive documents `flow mcp` serves as MCP Apps UI resources.
|
Package fragments holds the interactive documents `flow mcp` serves as MCP Apps UI resources. |
|
mcp
Package mcp is the protocol surface `flow mcp` serves: tool names and descriptions derived from the schema, the RPC dispatch table, and registration of both onto an *mcp.Server.
|
Package mcp is the protocol surface `flow mcp` serves: tool names and descriptions derived from the schema, the RPC dispatch table, and registration of both onto an *mcp.Server. |
|
pane
Package pane holds the pure components a full-screen view is assembled from.
|
Package pane holds the pure components a full-screen view is assembled from. |
|
policycheck
Package policycheck answers "who may act" for a compiled workflow without running it: for one identity, which of the workflow's authorization gates admit it, decided by the very functions the engine decides them with.
|
Package policycheck answers "who may act" for a compiled workflow without running it: for one identity, which of the workflow's authorization gates admit it, decided by the very functions the engine decides them with. |
|
policytest
Package policytest puts cases to a deployment policy and reports which rule denied each one that was denied, for `flow policy test`.
|
Package policytest puts cases to a deployment policy and reports which rule denied each one that was denied, for `flow policy test`. |
|
reference
Package reference holds the documents `flow mcp` serves as MCP resources.
|
Package reference holds the documents `flow mcp` serves as MCP resources. |
|
sarif
Package sarif renders Flowstate diagnostic reports as SARIF 2.1.0, the Static Analysis Results Interchange Format, so a code-scanning consumer (GitHub code scanning, an IDE's problems panel) reads `flow validate` without a bespoke parser.
|
Package sarif renders Flowstate diagnostic reports as SARIF 2.1.0, the Static Analysis Results Interchange Format, so a code-scanning consumer (GitHub code scanning, an IDE's problems panel) reads `flow validate` without a bespoke parser. |
|
taskexample
Package taskexample builds the smallest Flowfile step that runs a given task.
|
Package taskexample builds the smallest Flowfile step that runs a given task. |
|
tui
Package tui is the bubbletea shell a full-screen view of this CLI is built from: the parts of a screen that are about the terminal and not about what is being shown.
|
Package tui is the bubbletea shell a full-screen view of this CLI is built from: the parts of a screen that are about the terminal and not about what is being shown. |
|
tui/tuitest
Package tuitest holds the helpers a headless test of a full-screen model is written with: fold messages into a model without a terminal, click and press keys by name, and pin a screen.
|
Package tuitest holds the helpers a headless test of a full-screen model is written with: fold messages into a model without a terminal, click and press keys by name, and pin a screen. |
|
ui
Package ui decides, in one place, how the flow command line looks.
|
Package ui decides, in one place, how the flow command line looks. |
|
watch
Package watch is the TUI `flow watch` draws while a run is going, and the state machine both the live view and the plain, line-per-change shape fold their answers into.
|
Package watch is the TUI `flow watch` draws while a run is going, and the state machine both the live view and the plain, line-per-change shape fold their answers into. |
Click to show internal directories.
Click to hide internal directories.