Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

CLI Reference

redshank run

Run a one-shot investigation.

redshank run [OPTIONS] <OBJECTIVE>
OptionDefaultDescription
-w, --workspace <PATH>current directoryWorking directory for file tools and persisted state
-m, --model <MODEL>claude-sonnet-4-20250514Model name (for example claude-opus-4-5, gpt-4o)
-r, --reasoning <LEVEL>mediumReasoning effort: off, low, medium, high
--no-tuifalseDisable the interactive UI for command flows that support it
--max-depth <N>5Maximum recursion depth for sub-tasks
--demofalseEnable demo mode with redacted entity names

redshank tui

Launch the interactive TUI.

redshank tui [OPTIONS]
OptionDefaultDescription
-w, --workspace <PATH>current directoryWorkspace containing .redshank/ state
-m, --model <MODEL>claude-sonnet-4-20250514Model to use for new sessions
-r, --reasoning <LEVEL>mediumInitial reasoning effort
--session <ID>Resume an existing session by ID
--max-depth <N>5Maximum recursion depth for spawned sub-tasks
--demofalseEnable demo mode

redshank fetch

Run a standalone data fetcher.

redshank fetch uk_corporate_intelligence --query <QUERY> [--output <DIR>]
redshank fetch uk-corporate-intelligence --query <QUERY> [--output <DIR>]

Currently the CLI fetch dispatcher wires the UK corporate intelligence fetcher only.

OptionDefaultDescription
--query <QUERY>Required search term or company name
--output <DIR>current directoryDirectory where the NDJSON output file will be written

redshank session

Manage saved sessions.

redshank session list
redshank session resume <ID>
redshank session delete <ID>

redshank configure

Launch the interactive credential setup wizard.

redshank configure
redshank configure credentials
redshank setup

redshank configure credentials and redshank setup are compatibility aliases for the same interactive flow.

redshank version

Print the version and build info.