Back to Flow

Flow Commands Reference

docs/commands/readme.md

0.1.35.1 KB
Original Source

Flow Commands Reference

Complete documentation for all f (flow) commands.

Quick Reference

CommandDescription
deployDeploy to Linux hosts, Cloudflare Workers, or Railway
releasePublish a release to registry or GitHub
publishPublish project to GitHub
installInstall a CLI/tool via registry, parm, or flox
cloneClone repositories with git-like destination behavior
reposClone repositories into ~/repos
newCreate a project from a local template in ~/new
commitAI-powered commit with code review
prCreate/open PRs and ingest GitHub feedback
upstreamManage upstream fork workflow
envSync project environment and manage env vars
invariantsValidate project invariants from flow.toml
fastLow-latency AI task invocation via fast client
upBring a project up with lifecycle conventions
downBring a project down with lifecycle conventions
domainsShared local *.localhost route manager on port 80
tasksList and run project tasks
globalRun tasks from global flow config
setupPrint aliases or run setup task
aiManage AI coding sessions (Claude + Codex)
daemonManage background daemons
parallelRun tasks in parallel
docsManage auto-generated documentation
webOpen the Flow web UI for a project
urlInspect or crawl URLs into compact AI-friendly summaries

Getting Started

bash
# Show all commands
f --help

# Get help for a specific command
f deploy --help
f commit --help

Command Categories

Deployment

  • deploy - Deploy to hosts and cloud platforms
  • release - Publish releases to registries
  • publish - Publish project to GitHub

Version Control

  • commit - AI-powered commits with review
  • pr - PR creation/editing plus review feedback ingestion
  • clone - Clone with git-like destination behavior
  • repos - Clone repos into a structured directory
  • upstream - Fork management and sync
  • fixup - Fix common TOML syntax errors

Task Management

  • tasks - List project tasks
  • fast - Run AI tasks through the low-latency fast client path
  • up - Start project lifecycle (up/dev) with optional domains setup
  • down - Stop project lifecycle with optional domains teardown
  • global - Run tasks from ~/.config/flow/flow.toml
  • setup - Print aliases or run setup task
  • run - Run a specific task
  • parallel - Run tasks in parallel
  • rerun - Re-run last task
  • search - Fuzzy search global commands

Process Management

  • ps - List running flow processes
  • kill - Stop running processes
  • logs - View task logs
  • daemon - Manage background daemons

AI & Development

  • ai - Manage AI coding sessions
  • url - Inspect or crawl URLs into compact summaries for AI use
  • agent - Invoke AI subagents
  • match - Match natural language to tasks
  • sessions - Search AI sessions across projects

Environment & Configuration

  • env - Manage environment variables
  • invariants - Validate invariant policies in flow.toml
  • domains - Shared local domain proxy ownership and route management
  • init - Scaffold a new flow.toml
  • doctor - Verify tools and integrations

Project Management

  • new - Create a project from a local starter in ~/new
  • projects - List registered projects
  • active - Show or set active project
  • hub - Ensure hub daemon is running

Documentation

  • docs - Manage auto-generated documentation
  • commits - Browse commits with AI metadata

Legacy Compatibility

  • recipe - Legacy recipe command (hidden; prefer tasks + .ai/tasks/*.mbt)

Other

  • skills - Manage Codex skills
  • install - Install binaries via registry/parm/flox
  • db - Manage databases and providers
  • tools - Manage AI tools
  • notify - Send proposal notifications
  • server - Start HTTP server for logs

Global Options

bash
-h, --help     Print help
-V, --version  Print version

Configuration

Flow uses flow.toml for project configuration. See flow.toml reference for full documentation.

See Also