CLI Reference

This chapter provides a complete reference for all Flow CLI commands.

Note: Flow is in early development. Commands and options may change.

Global Options

These options can be used with any command:

Commands

flow capture

Quickly capture a thought without leaving your terminal.

flow capture "Your thought here #tag"

Arguments:

Examples:

# Simple capture
flow capture "Remember to update the docs"

# Capture with tags
flow capture "Research CRDT sync options #idea #research"

# Capture to a specific space
flow -s work capture "Meeting notes from standup"

flow search

Search your knowledge base.

flow search <QUERY>

Arguments:

Examples:

# Simple search
flow search "project ideas"

# Search with tags
flow search "#rust #async"

flow list

List notes in the current space.

flow list [OPTIONS]

Options:

flow init

Initialize a new Flow space.

flow init [PATH]

Arguments:

Examples:

# Initialize in current directory
flow init

# Initialize in a specific directory
flow init ~/notes/personal

UI Commands

These commands launch interactive interfaces (requires respective features to be compiled in).

flow tui

Launch the Terminal User Interface.

flow tui

Requires the tui feature.

flow gui

Launch the Desktop GUI application.

flow gui

Requires the gui feature.

flow serve

Start the Flow server for sync and web access.

flow serve [OPTIONS]

Requires the server feature.

Environment Variables

Exit Codes