CLI Reference
Command reference generated from the Flywheel Usage spec.
Inspect, organize, and operate Flywheel research graphs from the command line.
Command catalog
This reference is generated from flywheel --usage-spec and contains 138 command pages.
Setup Commands
| Command | Summary |
|---|---|
flywheel completion | Generate a shell completion script from the public Flywheel Usage spec |
flywheel completion bash | Generate a bash shell completion script |
flywheel completion fish | Generate a fish shell completion script |
flywheel completion install | Install a generated shell completion script to a user-level location |
flywheel completion nu | Generate a nu shell completion script |
flywheel completion nushell | Generate a nushell shell completion script |
flywheel completion powershell | Generate a powershell shell completion script |
flywheel completion uninstall | Remove Flywheel-managed shell completion files and profile blocks |
flywheel completion zsh | Generate a zsh shell completion script |
flywheel help | Show Flywheel CLI help. |
flywheel setup | Set up Flywheel for your AI coding host |
flywheel uninstall | Remove Flywheel MCP entries and bundled skills from selected hosts |
flywheel version | Print the Flywheel CLI version. |
Auth Commands
| Command | Summary |
|---|---|
flywheel auth:keychain:clear | Remove an API key from the OS keychain for a profile. |
flywheel auth:keychain:set | Store an API key in the OS keychain for a profile. Reads the key from stdin. |
flywheel auth:login | Bootstrap API key auth through RFC 8628 device authorization flow. |
flywheel auth:status | Show authentication status for the current client context. |
Profile Commands
| Command | Summary |
|---|---|
flywheel profile:list | List configured CLI profiles (local only). |
flywheel profile:set | Create or update a CLI profile (local only; never stores plaintext keys). |
flywheel profile:show | Show a profile definition (local only). |
flywheel profile:unset | Delete a CLI profile (local only). |
Nodes & Graph Commands
| Command | Summary |
|---|---|
flywheel campaign:snapshot | Resolve campaign root snapshot for a node. |
flywheel graph:get | Read the graph projection for navigation and topology workflows. |
flywheel nodes:add-parent | Add a parent-child edge (mirrors POST /nodes/{node_id}/parents/add). |
flywheel nodes:branch | Create a child branch from a node. |
flywheel nodes:children | Page direct visible children for one node. |
flywheel nodes:commit | Commit staged changes to an existing node. |
flywheel nodes:commit-new | Create and commit a new node in one request. |
flywheel nodes:create | Create a minimal node (title only) and emit graph-change event. |
flywheel nodes:delete | Delete a node by identifier. Requires --yes. |
flywheel nodes:delete-bulk | Delete multiple node subtrees. Requires --yes. |
flywheel nodes:files | List files attached to a node. |
flywheel nodes:get | Fetch one node by identifier. Use relationship paging commands for complete direct-neighbor traversal. |
flywheel nodes:list | List nodes with optional filters. |
flywheel nodes:merge | Merge multiple nodes into one resolved node. |
flywheel nodes:parents | Page direct visible parents for one node. |
flywheel nodes:remove-parent | Remove a parent-child edge. |
flywheel nodes:render:ancestry | Render ancestry (roots-ward lineage) for a node. |
flywheel nodes:render:summary | Render a compact summary of a node subtree. |
flywheel nodes:render:tree | Render a bounded tree projection for a node. |
flywheel nodes:resolve-slug | Resolve a slug to a node ID. |
flywheel nodes:sharing:get | Get sharing (access policy) for a node. |
flywheel nodes:sharing:set | Replace sharing (access policy) for a node. |
flywheel nodes:sharing:set-bulk | Apply one sharing policy to multiple nodes. |
flywheel nodes:sharing:summaries | Read access summaries for multiple nodes in one batch. |
flywheel nodes:stage:lease:acquire | Acquire an edit lease for an existing node. |
flywheel nodes:stage:lease:heartbeat | Heartbeat an active node stage lease. |
flywheel nodes:stage:lease:release | Release a node stage lease. |
flywheel remote-artifacts:refresh | Force refresh a public HTTPS JSON Remote Artifact for a node. |
flywheel remote-artifacts:resolve | Resolve a public HTTPS JSON Remote Artifact for a node. |
flywheel tags:assign | Assign or clear tags on a node (atomic replace). |
flywheel tags:create | Create a reusable tag on a graph root. |
flywheel tags:delete | Delete a tag definition from the graph. |
flywheel tags:update | Update a tag definition. |
Artifacts & Files Commands
| Command | Summary |
|---|---|
flywheel artifacts:delete | Delete an artifact from a node. |
flywheel artifacts:delete-bulk | Delete multiple artifacts from one node. |
flywheel artifacts:get | Fetch one artifact metadata record. |
flywheel artifacts:list | List artifacts for a node. |
flywheel artifacts:note:set | Add, update, or clear an artifact note. |
flywheel artifacts:upload | One-shot upload: prepare + PUT + finalize from a single invocation. |
flywheel artifacts:upload:finalize | Finalize prepared artifact uploads and attach artifacts. |
flywheel artifacts:upload:prepare | Create upload batch with signed per-item upload tickets. |
flywheel files:list | List all your files across nodes. |
Hooks Commands
| Command | Summary |
|---|---|
flywheel hooks:create | Create a new hook on an owner node. |
flywheel hooks:delete | Delete a hook from an owner node. |
flywheel hooks:list | List hooks configured for an owner node. |
flywheel hooks:runs:list | List hook runs for an owner node. |
flywheel hooks:secrets:create | Create a hook secret. |
flywheel hooks:secrets:delete | Delete one hook secret. |
flywheel hooks:secrets:list | List hook secret metadata for an owner node. |
flywheel hooks:secrets:update | Rotate one hook secret value. |
flywheel hooks:set-enabled | Enable or disable an existing hook. |
flywheel hooks:update | Update mutable hook fields for an existing hook. |
Compute & Executions Commands
| Command | Summary |
|---|---|
flywheel compute:acquire | Acquire managed compute for a node; with --wait, wait for usable SSH connection material. |
flywheel compute:budgets | List budget grants visible for a node context. |
flywheel compute:connection | Get SSH connection material for a usable lease. |
flywheel compute:funding | Read grant-scoped funding context before compute acquire. |
flywheel compute:options | List allowed compute catalog options for a node. |
flywheel compute:release | Release one active compute lease (async; use --wait to block). |
flywheel compute:release-all | Release all active leases in current scope (pass --force for account scope). |
flywheel compute:status | Return compute lease status. |
flywheel executions:launch | Start an execution for a node. |
flywheel executions:list | List executions for a node. |
flywheel executions:terminate | Stop an execution for a node. |
Approvals & Budgets Commands
| Command | Summary |
|---|---|
flywheel approval-sessions:expire | Expire an approval session. |
flywheel approval-sessions:heartbeat | Create or refresh a compute approval session. |
flywheel approval-sessions:list | List approval sessions. |
flywheel campaign-budgets:create | Create a campaign compute budget grant. |
flywheel campaign-budgets:list | List campaign compute budgets for a root. |
flywheel campaign-budgets:revoke | Revoke a campaign budget grant. |
flywheel campaign-budgets:update | Update a campaign budget. |
Export & Import Commands
| Command | Summary |
|---|---|
flywheel export:history | Export node history as JSONL. |
flywheel export:subgraph | Export a subgraph snapshot. |
flywheel export:summary | Generate a markdown summary export. |
flywheel export:summary:pdf | Render summary as PDF; requires --out. |
flywheel export:summary:render-pdf | Render caller-provided markdown as PDF; requires --out. |
flywheel export:summary:stream | Stream summary generation as NDJSON events. |
flywheel import:subgraph | Import graph JSON into new node records. |
Updates & Resources Commands
| Command | Summary |
|---|---|
flywheel blobs:get | Download a raw blob by storage key. |
flywheel machines:list | List your managed compute leases. |
flywheel updates:hide | Hide a specific announcement. |
flywheel updates:hide-all-active | Hide all currently active announcements. |
flywheel updates:list | List in-app announcements relevant to your account. |
flywheel updates:unhide | Restore a previously hidden announcement. |
Account & Credits Commands
| Command | Summary |
|---|---|
flywheel account:detach | Detach a linked alias account (requires confirm="DETACH"). Requires a browser session; API-key callers receive session_auth_required with /app?settings=user. |
flywheel account:emails:add | Add an email alias to your account. Requires a browser session; API-key callers receive session_auth_required with /app?settings=user. |
flywheel account:emails:remove | Remove an email alias from your account. Requires a browser session; API-key callers receive session_auth_required with /app?settings=user. |
flywheel account:emails:set-primary | Set your primary email address. Requires a browser session; API-key callers receive session_auth_required with /app?settings=user. |
flywheel account:get | View account snapshot and linked identities. |
flywheel account:merge | Execute an account merge (requires confirm="MERGE"). Requires a browser session; API-key callers receive session_auth_required with /app?settings=user. |
flywheel account:merge:preview | Preview what an account merge will do. Requires a browser session; API-key callers receive session_auth_required with /app?settings=user. |
flywheel account:merge:proof | Mint a merge proof token from a source session token. Requires a browser session; API-key callers receive session_auth_required with /app?settings=user. |
flywheel credits:balance | View credit balance and totals. |
flywheel credits:billing-portal | Open the Stripe billing portal for the current user and return browser_flow_required JSON with url, opened, and next_action. |
flywheel credits:purchase | Create a Stripe checkout session for a one-time purchase and return browser_flow_required JSON with url, opened, and next_action. |
flywheel credits:referral | View your referral code and status. |
flywheel credits:referral:claim | Claim referral rewards using a code. |
flywheel credits:subscribe | Create a Stripe checkout session for a subscription and return browser_flow_required JSON with url, opened, and next_action. |
flywheel credits:subscription | View your subscription status. |
flywheel credits:transactions | View paginated credit transactions. |
flywheel credits:usage | Feature-based usage breakdown over a window. |
Integrations Commands
| Command | Summary |
|---|---|
flywheel github:disconnect | Disconnect GitHub from your account. |
flywheel github:link | Start the GitHub App install/link browser flow. |
flywheel github:refresh-repos | Refresh the list of accessible repositories. |
flywheel github:status | Check GitHub connection status. |
flywheel integrations:huggingface:remove | Remove your Hugging Face credential. |
flywheel integrations:huggingface:set | Store a Hugging Face access token. |
flywheel integrations:status | Check integration connection status (W&B, Hugging Face). |
flywheel integrations:wandb:remove | Remove your W&B credential. |
flywheel integrations:wandb:set | Store a Weights & Biases API key. |
API Keys Commands
| Command | Summary |
|---|---|
flywheel api-keys:create | Create a new API key and return the raw material once. |
flywheel api-keys:delete | Delete an API key (refuses to delete the active one unless --allow-self). |
flywheel api-keys:list | List your API keys. |
flywheel api-keys:rotate | Rotate an API key (refuses to rotate the active one unless --allow-self). |
Other Commands
| Command | Summary |
|---|---|
flywheel compute-grants:list | List compute grants available to the user. |
flywheel compute-grants:request-approval | Request compute-grant approval. POSTs to the consolidated server endpoint which owns the heartbeat/grants/credits/campaign-budgets/status fan-out. |
flywheel feedback:create | Submit bounded feedback to the Flywheel team. |
flywheel update | Update the local Flywheel CLI package and setup artifacts |