# Flywheel Docs Canonical URL: https://docs.flywheel.paradigma.inc Flywheel is infrastructure for autonomous research workflows. Use these docs to install the CLI, connect supported agent hosts through MCP, understand the graph model, and inspect the CLI and API reference material. New users should begin with the tutorial, then use the install and MCP setup pages when wiring a local host. ## Common paths [#common-paths] --- # Install Canonical URL: https://docs.flywheel.paradigma.inc/install Choose the environment where you normally launch your AI coding host. WSL and native Windows have separate home directories and host config files, so install Flywheel in the same environment that starts Codex, Claude Code, Cursor, or another host. The canonical local install for macOS, Linux, and WSL uses the Flywheel installer: ```bash curl -fsSL https://flywheel.paradigma.inc/install | sh ``` The installer places the CLI in the managed user prefix `${FLYWHEEL_INSTALL_PREFIX:-$HOME/.local}`, updates PATH when needed, and starts guided setup. After installation, use `flywheel help` for the command list or browse the [CLI reference](/cli) for generated command pages. ## Windows with WSL [#windows-with-wsl] Use this path when your normal AI coding workflow starts inside WSL. From PowerShell, install WSL if needed: ```powershell wsl --install ``` Restart Windows if the installer asks you to, then launch your distro from the Start menu or from PowerShell: ```powershell wsl -d Ubuntu ``` To inspect or choose a distro: ```powershell wsl --list --online wsl --install -d Ubuntu wsl -l -v wsl -d Ubuntu ``` Inside the WSL distro, install Node.js 20+ and npm. Node.js and npm installed only on the Windows side are not available to the WSL installer. Then run the Linux installer inside WSL: ```bash curl -fsSL https://flywheel.paradigma.inc/install | sh ``` Flywheel writes WSL-side config, so launch your AI coding host from the same WSL environment. If browser auth does not open automatically from WSL, copy the printed approval URL and setup code into your Windows browser. ## Native Windows PowerShell [#native-windows-powershell] Use this path when your normal AI coding workflow starts in native PowerShell, Command Prompt, or a native Windows desktop app. ```powershell $prefix = "$env:USERPROFILE\.local" npm install -g --prefix $prefix @paradigma-inc/flywheel@latest $userPath = [Environment]::GetEnvironmentVariable("Path", "User") if (($userPath -split ";") -notcontains $prefix) { $nextUserPath = if ($userPath) { "$prefix;$userPath" } else { $prefix } [Environment]::SetEnvironmentVariable("Path", $nextUserPath, "User") } if (($env:Path -split ";") -notcontains $prefix) { $env:Path = "$prefix;$env:Path" } # MCP host wiring for native Windows hosts & "$prefix\flywheel.cmd" setup --mode mcp ``` Use `--mode mcp` when your native Windows host should call Flywheel tools directly. Use `--mode cli` instead when your workflow should call the `flywheel` binary directly and you do not want MCP host config written. Do not install in both WSL and native Windows unless you intentionally want two separate Flywheel setups. ## MCP mode [#mcp-mode] ```bash curl -fsSL https://flywheel.paradigma.inc/install | sh -s -- --mode mcp ``` Use MCP mode when your host should call Flywheel tools natively. On native Windows, use the PowerShell command in the section above instead of the POSIX `curl | sh` installer. ## CLI mode [#cli-mode] ```bash curl -fsSL https://flywheel.paradigma.inc/install | sh -s -- --mode cli ``` Use CLI mode when your workflow should call the `flywheel` binary directly. See [`flywheel setup`](/cli/setup) for the full setup flag reference. ## Uninstall [#uninstall] ```bash curl -fsSL https://flywheel.paradigma.inc/uninstall | sh ``` Uninstall removes local Flywheel runtime files and host wiring. It does not delete remote account data, graphs, nodes, artifacts, billing data, GitHub connections, or remote resources. See [`flywheel uninstall`](/cli/uninstall) for the full uninstall flag reference. --- # Quickstart Canonical URL: https://docs.flywheel.paradigma.inc/quickstart On Windows, choose the install environment by where your AI coding host runs: use WSL when you launch the host from WSL, and use native PowerShell when the host runs as a native Windows process. See [Install](/install) for the full Windows and WSL commands. Install Flywheel with the installer on macOS, Linux, or WSL: ```bash curl -fsSL https://flywheel.paradigma.inc/install | sh ``` After setup, open the [Flywheel Web UI](https://flywheel.paradigma.inc) to inspect the Canvas, then use your CLI or MCP host to create and inspect graph nodes. ## First checks [#first-checks] ```bash flywheel help flywheel auth:status flywheel nodes:list --page 1 ``` Use the [CLI reference](/cli) for command details and the [tutorial](/tutorial) for a guided walkthrough. --- # Flywheel Tutorial Canonical URL: https://docs.flywheel.paradigma.inc/tutorial > Note: We are constantly iterating, so some aspects of this tutorial may be > stale. Welcome to Flywheel. Below we will cover how to install Flywheel and some tips on usage patterns. ## What is Flywheel? [#what-is-flywheel] Flywheel's ambition is to serve as the infrastructure upon which autonomous science will run. In its current iteration, you can think of Flywheel as *"git for research"*, to aid researchers and agents in working on research projects. While in SWE we use git to manage changes to code, in research we are interested in manipulating ideas. Flywheel provides the DAG structure and operations (branching, merging, etc) to manage this. ## Setting up Flywheel [#setting-up-flywheel] We are in the business of automating science. The canonical local Flywheel install gives you the `flywheel` CLI and bundled agent skills. You can then optionally wire Flywheel into compatible hosts through the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro). MCP enables compatible hosts to call Flywheel tools natively. We recommend using Flywheel with [Codex](https://github.com/openai/codex) or [Claude code](https://github.com/anthropics/claude-code), but any compatible MCP host should work. ### One-command setup (recommended) [#one-command-setup-recommended] Simply run: ```bash curl -fsSL https://flywheel.paradigma.inc/install | sh ``` This installs the `flywheel` CLI into the managed user prefix `${FLYWHEEL_INSTALL_PREFIX:-$HOME/.local}`, configures PATH when needed, and starts guided setup. In an interactive terminal, setup asks whether you want MCP host setup or CLI-only setup. See [Install modes](#install-modes) below for the CLI and MCP options. On Windows, first choose the environment that launches your AI coding host. If you use Codex, Claude Code, Cursor, or another host from WSL, open that WSL distro, install Node.js 20+ and npm inside WSL, and run the Linux installer there. If your host runs as a native Windows process, use the native PowerShell recipe on the [Install](/install) page. To install directly into MCP mode instead, pass setup arguments through the installer: ```bash curl -fsSL https://flywheel.paradigma.inc/install | sh -s -- --mode mcp ``` If you are on a remote shell (for example SSH into a server), use device auth: ```bash curl -fsSL https://flywheel.paradigma.inc/install | sh -s -- \ --mode mcp \ --auth-mode device \ --base-url https://flywheel.paradigma.inc ``` Use the public Flywheel origin (`flywheel.paradigma.inc`) for `--base-url`, not backend Fly hostnames. Device auth prints an approval URL and setup code; if browser auth does not open from WSL or a remote shell, copy both values into the browser you use to approve setup. ### Reinstall / cleanup [#reinstall--cleanup] ```bash curl -fsSL https://flywheel.paradigma.inc/uninstall | sh curl -fsSL https://flywheel.paradigma.inc/install | sh ``` The uninstall script removes Flywheel MCP entries, bundled skills, the managed-prefix CLI package and binary, installer-owned PATH block, default CLI config/profiles, and the local runtime cache. It does not delete remote Flywheel account data, nodes, artifacts, billing data, GitHub connections, or other remote resources. Re-running the install script afterwards starts from a clean guided local state. To reinstall into MCP mode after cleanup, pass `--mode mcp` through the install script: ```bash curl -fsSL https://flywheel.paradigma.inc/install | sh -s -- --mode mcp ``` ### Web connector hosts (ChatGPT.com / Claude.ai / etc. ) [#web-connector-hosts-chatgptcom--claudeai--etc-] Web connector hosts can still use OAuth-style connector flows. Keep using those host-native connector install UIs for ChatGPT.com custom apps, Claude.ai custom connectors, etc. Simply put `https://flywheel.paradigma.inc/mcp-server` as the URL when prompted. ## Install modes [#install-modes] `setup` has two install modes. CLI mode is the canonical local install; MCP mode is optional host wiring for agents that should call Flywheel tools natively. ### CLI mode [#cli-mode] ```bash npx --yes @paradigma-inc/flywheel setup --mode cli ``` `--mode cli` installs the bundled Flywheel skills and configures runtime credentials/config for the `flywheel` binary. No MCP host config is written. Your agent then talks to Flywheel by shelling out to the `flywheel` binary; the bundled skills route to the matching CLI command for each operation. Prerequisite for bare `flywheel ` routing after CLI-mode setup: install the binary through the curl installer or the managed-prefix npm recipe. ```bash curl -fsSL https://flywheel.paradigma.inc/install | sh -s -- --mode cli ``` Pick this when you do not want to wire MCP into your host config, or when your agent prefers shelling out to a CLI over calling MCP tools. ### MCP mode [#mcp-mode] ```bash npx --yes @paradigma-inc/flywheel setup --mode mcp ``` `--mode mcp` wires Flywheel MCP into your host's config and installs the bundled Flywheel skills. Your agent then talks to Flywheel through your MCP host, calling `flywheel_*` MCP tools. Pick this when your host (Codex, Claude Code, Cursor, OpenCode, Gemini CLI, Pi, Hermes Agent, OpenClaw) supports MCP and you want native MCP-tool integration. ### Run `flywheel` commands directly [#run-flywheel-commands-directly] In either mode, you can also type `flywheel` commands yourself. For occasional use: ```bash npx --yes @paradigma-inc/flywheel ``` For regular use, install the binary so `flywheel` is on your `PATH`: ```bash curl -fsSL https://flywheel.paradigma.inc/install | sh -s -- --mode cli FLYWHEEL_BIN="${FLYWHEEL_INSTALL_PREFIX:-$HOME/.local}/bin/flywheel" "$FLYWHEEL_BIN" help # list all commands "$FLYWHEEL_BIN" help # per-command usage, examples, and JSON schema "$FLYWHEEL_BIN" auth:status # confirm the runtime is authenticated "$FLYWHEEL_BIN" nodes:list --page 1 # read example ``` Open a new shell, or source the profile file named by the installer, before using the bare `flywheel` command. See the [CLI reference](/cli) for the full command catalog grouped by capability area, the `setup` / `uninstall` flag matrix, and runtime config resolution. ## What to do with Flywheel? [#what-to-do-with-flywheel] In our experience the best way to get an answer to this question is to ask it to your MCP host: ```console $ codex "tell me about flywheel, what can i do with it?" In this workspace, Flywheel is a node-based system for organizing and executing work (especially research/experiments) with reproducibility and auditability built in. What you can do with it: - Create work nodes and classify them as insight (thinking/analysis) or empirical (actual experiments). - Build a graph of work with branching/merging, not just a linear log. - Commit outcomes with required structure (kind, outcome, summary) so results stay consistent. - Launch managed compute for a node with budget controls and track execution state. - Attach artifacts to nodes (text, tables, JSON, images, HTML/plots, checkpoints, diffs). - Configure hooks to call external HTTP endpoints when node events occur. - Collaborate with others by sharing nodes/graphs. - Tag nodes, audit changes, and export summaries/PDFs/subgraphs. Typical use cases: - Experiment tracking with hypotheses + evidence. - Decision logs and technical investigations. - Team-shared research graphs with reproducible outputs. - Converting a messy exploration into a reviewable, auditable record. If you want, I can walk you through creating your first node and a minimal workflow for your current project. ``` Francesco is documenting some example workflows on his [X profile](https://x.com/tensorqt), like [organizing, exploring and iterating on a research topic](https://x.com/tensorqt/status/2032190671281332280?s=20) or [reproducing papers on a budget](https://x.com/tensorqt/status/2032555892399305171). We'll be sharing more example workflows there and also through our [Discord](https://discord.gg/aFg4zskefj), where we do weekly office hours. You should join! ## The Flywheel Web UI [#the-flywheel-web-ui] While most of your write-driven interactions with Flywheel will likely be through your MCP host, you will find the [Flywheel Web UI](https://flywheel.paradigma.inc) useful for visualizing your graph and managing nodes, settings, and account workflows. The Flywheel Web UI presents itself as a "Canvas" where the directed acyclic graph of nodes is visualized. Initially this graph will be empty, but gets populated as you create nodes through your MCP host. With the top right visibility dropdown, you can also view graphs that have been shared with you or have been made public. You can drag the nodes around to organize them, hover over them to preview their content and click on them for more details. You can pan and zoom around the canvas. graph view with public view enabled You can also toggle timeline view for a more organized, linear view of the graphs: graph view with timeline You can also shift select some nodes and generate summaries of their content and or export them as PDFs and/or JSON files for others to import. Of course, you can also use your MCP host to generate summaries and overviews of your research graph. Inside a node, you will be able to see its content, summary, tags, and attached artifacts. example node view ## Hooks (Automations on Events) [#hooks-automations-on-events] Flywheel Hooks let you automate actions when node events happen. For the full workflow guide, see [Hooks And Automations](/concepts/hooks). * An **event** is a durable "something happened" record. Supported events are `artifact.finalized` after artifact finalize writes succeed and `node.published` after an eligible submission node becomes public. * A **hook** is a durable rule on a node that says: when event X happens in scope Y, perform action Z. * A **run** is one execution record for one hook reacting to one event. You can configure hooks in two ways: 1. In the Web UI, open a node and use the **Hooks** panel in the right-side node panel area. 2. In MCP, use the hook tools directly: * `flywheel_create_hook`, `flywheel_update_hook`, `flywheel_set_hook_enabled`, `flywheel_delete_hook`, `flywheel_list_hooks` * `flywheel_create_hook_secret`, `flywheel_update_hook_secret`, `flywheel_delete_hook_secret`, `flywheel_list_hook_secrets` * `flywheel_list_hook_runs` Recommended setup flow: 1. Create hook secrets (if your endpoint needs auth). 2. Create a hook whose `workflow_yaml.on` declares one or more supported events, a scope (`self`, `subtree`, or `graph`), and a workflow that defines your action steps. 3. Set `workflow_yaml.if` to target the event shape you care about. 4. Enable the hook. 5. Finalize an artifact upload and inspect run history with `flywheel_list_hook_runs`. `workflow_yaml.if` supports deterministic operators: * `all`, `any`, `not`, `event`, `any_artifact` * predicate operators: `eq`, `in`, `exists` Example: trigger when at least one public attempt submission artifact is finalized or when an eligible existing submission artifact becomes public with the node: ```yaml on: artifact.finalized: {} node.published: {} if: all: - any: - event: field: event_type eq: artifact.finalized - event: field: event_type eq: node.published - any_artifact: field: metadata.campaign_role eq: submission jobs: main: steps: - id: notify uses: flywheel/http_request@v1 with: url: https://example.invalid/flywheel-hooks/artifact-finalized ``` "None artifact matches" is expressed with `not: { any_artifact: ... }`, for example: ```yaml if: not: any_artifact: field: metadata.campaign_role eq: submission ``` Run cardinality is fixed: workflow-if evaluation yields one boolean per hook/event and enqueues at most one run per `(hook_id, event_id)` (no artifact fanout). Campaign submission artifacts follow the campaign's submission visibility policy. Current public-policy campaigns require the attempt node to be public before finalizing an artifact with `metadata.campaign_role = "submission"`. Invalid non-public submissions fail during artifact finalization before submission hooks run. Workflow steps currently support: * `flywheel/http_request@v1` * `flywheel/http_poll@v1` * `flywheel/json_extract@v1` * `flywheel/load_artifact@v1` * `flywheel/upsert_artifact@v1` * `flywheel/add_node_tags@v1` `flywheel/upsert_artifact@v1` uses `with.match` to select the artifact to update. Use `match.metadata` for subset matching and keep selectors unique; ambiguous selectors fail terminally. Campaign workflows should keep contestant-authored submission artifacts (`campaign_role=submission`) on the attempt node, then write root-owned evaluation artifacts (`campaign_role=evaluation`) onto the campaign root. `flywheel/add_node_tags@v1` adds ordinary root graph tags to a target node while preserving existing tag assignments. It rejects one-only tags in v1. ## Managed Compute [#managed-compute] Flywheel can provision managed GPU instances for you from providers like Lambda Labs, Modal, Vast.ai, Prime Intellect, Nebius, and RunPod — directly from your agent conversation. You don't need to leave your workflow to spin up machines. ### How it works [#how-it-works] 1. **Ask your agent for compute.** When you need a GPU for an experiment, just say so: ```console $ codex "I need a GPU to train a small transformer on this dataset" I'll provision a GPU for this node. First, I need you to approve a budget. Opening the approval page now... ``` 2. **Approve a budget.** Flywheel opens an approval page in your browser where you set a spending cap for managed compute acquisition. 3. **The agent handles the rest.** It acquires a machine, waits for it to become ready, and gets SSH access automatically. Provisioning typically takes a few minutes — the agent polls for readiness in the background. 4. **Release when done.** When you're finished, the agent releases the lease. You can also release leases from the Web UI at any time. ### Managing machines in the Web UI [#managing-machines-in-the-web-ui] In **Settings > Machines**, you can see all GPU leases across your account — including the provider, state, hourly rate, total spend, and the acquire context that originally launched each lease. You can release individual leases or all at once. settings machines view Inside a node, the node view focuses on compute policy and budget tracking (spent vs. hard cap). Active machines themselves are managed from the account level **Settings > Machines** view. ### Credits and billing [#credits-and-billing] Compute is billed against your Flywheel credits balance, which is separate from your subscription. * The **Pro subscription** ($20/month or $204/year) includes $10 in non-rollover credits each Pro cycle. Those credits refresh when the plan renews, while separately purchased credits do not expire. * During beta, **Pro (Beta)** users receive the same Pro-cycle credit allowance without billing while beta access remains active. * You can check your balance in **Settings > Credits**. * Before any compute is provisioned, you approve a spending cap — no surprises. * **User budgets** fund your own managed compute usage. Campaign organizers can also fund participant compute through root-backed campaign budgets (more on this in the next section). ### Tips [#tips] * Provisioning takes a few minutes — the agent polls automatically, so you don't need to babysit it. * You can walk away; Flywheel continues while the machine spins up. * Release leases when you're done to save credits. ## Integrations [#integrations] Flywheel can hold credentials for external tools so machines launched by your agent can pull artifacts from and push logs to your own accounts. Manage these from **Settings > Integrations** in the Web UI, or from the CLI: * **Weights & Biases** — store a W\&B API key so executions can stream metrics to your W\&B project: `flywheel integrations:wandb:set`. * **Hugging Face** — store an HF access token so executions can pull gated models or push checkpoints: `flywheel integrations:huggingface:set`. * **GitHub** — link a GitHub installation so Flywheel can resolve repos for node workspaces and executions: `flywheel github:link`. Use `flywheel integrations:status` (and `flywheel github:status`) to see which integrations are currently connected, and the matching `:remove` / `github:disconnect` commands to revoke them. For the full integrations command list, see the [CLI reference](/cli). ## Participating in a Campaign [#participating-in-a-campaign] Campaigns are challenge-style Flywheel graphs where an organizer shares a root graph, defines the objective and submission contract, and may fund participant compute through campaign budgets. To participate in a campaign: 1. Get access to the campaign root. Invite-only campaigns are shared directly with your Flywheel account. Open campaigns are made public by the organizer. 2. Open the campaign in the Web UI or ask your MCP host to inspect the root node. 3. Read the campaign root carefully before you start. Organizers can define the objective, submission format, graph hygiene, repo policy, GPU guidance, and any evaluation rules directly on the root. 4. Do your work in your own part of the graph. Use Flywheel nodes to record your progress, artifacts, summaries, and conclusions so your submission stays reviewable. When the campaign asks for a canonical submission artifact, write that artifact on your own attempt node and follow the campaign visibility policy before finalizing it. Organizer hooks can evaluate valid submissions and refresh leaderboard artifacts on the campaign root without writing back onto your node. 5. If the campaign provides compute funding, discover the available campaign budgets, request approval, then acquire compute against the returned session `compute_grant_id`. The practical rule is simple: the campaign root tells you the contract, and your graph is how you show your work. Once a valid submission artifact is finalized, Flywheel creates a lifecycle record for it. Agents should query that record instead of inferring status from hook rows or external scoreboards: use `flywheel_get_artifact_campaign_submission` for a known node/artifact pair, `flywheel_list_node_campaign_submissions` for an attempt node, or `flywheel_get_campaign_submission` for a known submission id. Invalid submissions fail immediately with `422` and do not create a lifecycle record. `forwarded` means Flywheel handed the submission to campaign automation; the terminal states are `scored`, `rejected`, and `failed`. ### Coming Soon [#coming-soon] * A dedicated tutorial section for setting up a campaign as an organizer. * A dedicated tutorial section for sponsoring or funding a campaign. ## FAQ: How Do I Migrate from the Previous OAuth-Based MCP Client Setup? [#faq-how-do-i-migrate-from-the-previous-oauth-based-mcp-client-setup] If you installed Flywheel MCP before April 2026, migrate to the newer, more stable API key authentication setup with: ```bash curl -fsSL https://flywheel.paradigma.inc/uninstall | sh curl -fsSL https://flywheel.paradigma.inc/install | sh -s -- --mode mcp ``` If your previous install used a server name different from `flywheel`, pass `--name ` to uninstall that specific entry. If you prefer the canonical CLI install instead of recreating MCP host entries, omit the setup arguments on reinstall: ```bash curl -fsSL https://flywheel.paradigma.inc/install | sh ``` ## FAQ: Setup Fails On Remote SSH Machines With localhost / 127.0.0.1 Redirect Errors [#faq-setup-fails-on-remote-ssh-machines-with-localhost--127001-redirect-errors] When setup runs on a remote machine, localhost callback URLs resolve on that remote machine, not on your laptop browser. Use device auth: ```bash npx --yes @paradigma-inc/flywheel setup \ --mode mcp \ --auth-mode device \ --base-url https://flywheel.paradigma.inc ``` `--auth-mode device` prints an approval URL and setup code; approve in browser and the CLI polls until your API key is issued. ## FAQ: My MCP Host Is Not Supported by the Setup Wizard. How Do I Install Flywheel? [#faq-my-mcp-host-is-not-supported-by-the-setup-wizard-how-do-i-install-flywheel] If your host is not currently supported by `npx --yes @paradigma-inc/flywheel setup --mode mcp`, you can still connect manually. 1. In the Flywheel Web UI, open **Settings**, go to the **User** tab, expand **MCP API keys**, and click **Create key**. 2. Copy the key immediately (it is shown once). 3. Add a Flywheel MCP server entry in your host config with: * URL: `https://flywheel.paradigma.inc/mcp-server` * Header: `Authorization: Bearer ` Example JSON-style host config: ```json { "mcpServers": { "flywheel": { "type": "http", "url": "https://flywheel.paradigma.inc/mcp-server", "headers": { "Authorization": "Bearer " } } } } ``` Example TOML-style host config: ```toml [mcp_servers.flywheel] type = "http" url = "https://flywheel.paradigma.inc/mcp-server" [mcp_servers.flywheel.headers] Authorization = "Bearer " ``` Different hosts use different field names (`mcpServers`, `mcp_servers`, `mcp.servers`, etc.), but the server URL and `Authorization` bearer header are the key pieces. Alternative: for any host that supports MCP OAuth, you can use its OAuth connector install flow and set the MCP URL to `https://flywheel.paradigma.inc/mcp-server`. Web connector hosts (for example ChatGPT.com, Claude.ai) commonly use this path. It can be convenient, but it may prompt re-authorization more often than the API key route depending on the host token lifecycle and refresh behavior. ## FAQ: How Can I Get an Authorized `client_id` for the OAuth Flow? [#faq-how-can-i-get-an-authorized-client_id-for-the-oauth-flow] We support the standard MCP OAuth flow with dynamic client registration, as documented in the [MCP Authorization spec (dynamic client registration)](https://modelcontextprotocol.io/specification/2025-11-25/basic/authorization#dynamic-client-registration). First, query our OAuth authorization-server metadata: ```bash curl -sS https://flywheel.paradigma.inc/mcp-server/.well-known/oauth-authorization-server | jq ``` That response includes the OAuth endpoints (`authorization_endpoint`, `token_endpoint`, `registration_endpoint`, and others). `response_types_supported` is currently `["code"]`, so register with `"response_types":["code"]`. Then register your OAuth client using the `registration_endpoint`. ### Public client (default) [#public-client-default] This is the default for interactive MCP hosts (for example Claude Code, IDE hosts, local desktop clients). If `token_endpoint_auth_method` is omitted, we default to `none`. ```bash curl -sS -X POST https://flywheel.paradigma.inc/mcp-server/register \ -H "content-type: application/json" \ -d '{ "client_name":"Flywheel MCP Host", "redirect_uris":["http://localhost:3333/callback"], "grant_types":["authorization_code","refresh_token"], "response_types":["code"] }' | jq ``` The response returns a `client_id` and no `client_secret`. ### Confidential client (optional) [#confidential-client-optional] Use this when your app has a trusted backend that can securely store secrets. ```bash curl -sS -X POST https://flywheel.paradigma.inc/mcp-server/register \ -H "content-type: application/json" \ -d '{ "client_name":"Flywheel MCP Connector Backend", "redirect_uris":["https://YOUR_CALLBACK_URL"], "grant_types":["authorization_code","refresh_token"], "response_types":["code"], "token_endpoint_auth_method":"client_secret_post" }' | jq ``` That response returns both `client_id` and `client_secret`. Keep `client_secret` private in your backend. --- # API Reference Canonical URL: https://docs.flywheel.paradigma.inc/api {/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} --- # Campaigns Canonical URL: https://docs.flywheel.paradigma.inc/concepts/campaigns Campaigns are challenge-style Flywheel graphs. An organizer owns a campaign root, describes the objective, and publishes structured campaign config. A participant works in attempt nodes and finalizes artifacts that the campaign can project into snapshots, views, records, outputs, or hook-driven automations. ## Submission Artifacts [#submission-artifacts] A campaign submission is a finalized artifact whose metadata marks it as a submission: ```json { "metadata": { "campaign_role": "submission" } } ``` Use that metadata only for the artifact that should count as a campaign submission. Private scratch artifacts, notes, traces, and drafts should use ordinary metadata until they are ready to be submitted under the campaign's rules. ## Visibility Policy [#visibility-policy] Campaign config can declare a submission visibility policy: ```json { "version": 1, "submission_policy": { "required_visibility": "public" }, "attempt_selector": {}, "views": [], "records": [], "outputs": [] } ``` The current supported policy is `required_visibility: "public"`. For campaigns using that policy, the source node must be public before the submission artifact is finalized. If a public-policy campaign submission is finalized from a private, unlisted, or shared-only node, Flywheel rejects the finalize request with a validation error. The artifact is not accepted silently, and submission hooks do not run for that invalid finalize attempt. ## Submission Lifecycle Status [#submission-lifecycle-status] When Flywheel accepts a valid submission artifact, it also creates a durable campaign submission lifecycle record. Agents and users can query that record instead of guessing from hook runs, leaderboard artifacts, or external scoring systems. Use these MCP tools after finalizing a submission artifact: * `flywheel_get_artifact_campaign_submission` when you know the attempt node id and artifact id. * `flywheel_list_node_campaign_submissions` to list recent submission statuses for an attempt node. * `flywheel_get_campaign_submission` when you already have a submission id. Common states are: * `accepted`: Flywheel accepted the submission artifact. * `forwarding`: campaign automation is currently processing the submission. * `forwarded`: Flywheel successfully handed the submission to campaign automation. This does not necessarily mean an external scorer has finished. * `rate_limited` or `retrying`: downstream automation asked Flywheel to try again later. * `scored`, `rejected`, or `failed`: terminal states. Invalid submissions fail immediately with `422` and do not create a lifecycle record. ## Agent Checklist [#agent-checklist] Before finalizing an artifact with `metadata.campaign_role = "submission"`: 1. Read the campaign root and campaign config. 2. Check `submission_policy.required_visibility`. 3. If it is `public`, make the attempt node public before finalizing the submission artifact. 4. Finalize the submission artifact. 5. Query the lifecycle record with `flywheel_get_artifact_campaign_submission` or `flywheel_list_node_campaign_submissions`. 6. Keep private drafts as ordinary artifacts without marking `campaign_role` as `submission`. Missing `submission_policy` currently behaves like `required_visibility: "public"` so older campaign configs keep the same public-submission behavior. --- # Graph Model Canonical URL: https://docs.flywheel.paradigma.inc/concepts/graph-model Flywheel organizes research work as a directed graph. Nodes represent work units, branches represent divergent paths, and merged outcomes preserve a reviewable record of decisions and evidence. The graph model is useful when an investigation branches into alternatives, when empirical work needs artifacts attached to the work that produced them, or when a team needs a durable audit trail for agent-assisted work. ## Nodes And Edges [#nodes-and-edges] A node is the durable unit of work. It can hold a question, claim, hypothesis, task, result, or decision. Edges connect nodes into an ancestry graph so later work can point back to the context that motivated it. A branch creates a child node from an existing node; a merge records that multiple branches have been resolved into one outcome. This shape lets you keep alternatives visible without flattening everything into one timeline. A failed experiment, a competing explanation, and a final decision can all stay connected to the same parent while preserving their own evidence. ## Reading The Graph [#reading-the-graph] Use the Web UI when you want to inspect topology visually. Use the CLI or MCP when you need a repeatable read for an agent or script: ```bash flywheel nodes:list --page 1 flywheel nodes:get --node_id flywheel nodes:children --node_id flywheel nodes:parents --node_id ``` For full command details, see [`nodes:list`](/cli/nodes-list), [`nodes:get`](/cli/nodes-get), and the broader [CLI reference](/cli). ## Practical Modeling Guidance [#practical-modeling-guidance] Prefer small, reviewable nodes over one large catch-all node. Put the current claim or task in the node content, attach concrete evidence as artifacts, and use child nodes for follow-up work that can succeed or fail independently. When a branch changes your conclusion, update the summary and connect the outcome back into the graph. The goal is not to make every investigation neat; it is to make the lineage of evidence and decisions inspectable later. For a practical research workflow built on this graph model, see [Encoding the Scientific Method](/how-to-use-flywheel/encoding-the-scientific-method). --- # Hooks And Automations Canonical URL: https://docs.flywheel.paradigma.inc/concepts/hooks Flywheel Hooks are durable rules configured on nodes. A hook watches for a supported event, checks whether the event is in scope, evaluates the workflow filter, and creates an observable asynchronous run when the event matches. Use hooks when a graph needs repeatable automation around artifacts: notify an external service, enrich a node after a submission, write a derived artifact, or tag a participant attempt for later review. ## Core Terms [#core-terms] * An **event** is a durable record that something happened. Supported trigger events are `artifact.finalized`, emitted after artifact finalize writes succeed, and `node.published`, emitted when an eligible submission node becomes public. * A **hook** is the durable rule stored on an owner node. * The **owner node** determines who owns the hook and where hook secrets live. * **Scope** controls which event source nodes the hook can match. * A **workflow** is the `workflow_v1` YAML stored in `workflow_yaml`. * A **secret** is an encrypted, node-scoped credential referenced from workflow YAML as `${{ secrets.NAME }}`. * A **run** is one execution record for one hook reacting to one event. * **Run history** is where you inspect queued, running, succeeded, and failed hook runs. Hook execution is asynchronous. A hook failure does not roll back the artifact write that created the event. ## Trigger And Scope [#trigger-and-scope] Declare one or more supported trigger events under `workflow_yaml.on`. `artifact.finalized` runs after successful artifact finalize writes. `node.published` runs after a node changes from non-public to public and has an eligible submission artifact. The hook scope determines which source-node events can match: * `self`: match events sourced from the hook owner node only. * `subtree`: match events sourced from the hook owner node itself, plus descendant or attempt nodes under that owner. * `graph`: match source-node events where the hook owner is the source node or appears in the source node ancestry. This is not a separate graph-level event stream. Use `self` for local node automation, `subtree` for organizer-owned automation over participant attempt nodes, and `graph` only when current API or MCP contract guidance calls for graph-scope matching. ## Workflow Filters [#workflow-filters] Set `workflow_yaml.if` when the hook should only run for a specific event shape. The supported deterministic operators are `all`, `any`, `not`, `event`, `any_artifact`. Predicate operators include `eq`, `in`, and `exists`. This filter matches finalized public attempt artifacts with `metadata.campaign_role` equal to `submission`, and it also matches publication-triggered submission processing when an eligible private attempt later becomes public: ```yaml on: artifact.finalized: {} node.published: {} if: all: - any: - event: field: event_type eq: artifact.finalized - event: field: event_type eq: node.published - any_artifact: field: metadata.campaign_role eq: submission jobs: main: steps: - id: notify uses: flywheel/http_request@v1 with: url: https://example.invalid/flywheel-hooks/artifact-finalized ``` Use `not: { any_artifact: ... }` for a negative artifact match: ```yaml if: not: any_artifact: field: metadata.campaign_role eq: submission ``` Run cardinality is fixed: workflow-if evaluation yields one boolean per hook/event and enqueues at most one run per `(hook_id, event_id)`. Hooks do not fan out into one run per artifact. Campaign submission artifacts follow the campaign's submission visibility policy. Current public-policy campaigns require the attempt node to be public before finalizing an artifact with `metadata.campaign_role = "submission"`. Invalid non-public submissions fail during artifact finalization, before a submission hook run is created. The `node.published` trigger can process already-finalized artifacts after a node becomes public, but it does not make rejected campaign submissions valid. Default rerun policy is `if_inputs_changed`: unchanged inputs for the same hook and target node do not enqueue another run, while changed inputs can run again. ## Create A Hook In The Web UI [#create-a-hook-in-the-web-ui] Open a node and use the Hooks panel in the node details area. 1. Add a Hook Name. 2. Declare one or more supported events in `workflow_yaml.on`. 3. Choose Scope: `self`, `subtree`, or `graph`. 4. Paste the Workflow YAML. 5. Add Secrets if the workflow calls an authenticated service. 6. Use Enable immediately when the hook should start matching new events. 7. Finalize an artifact or publish an eligible submission node and inspect Recent Runs. Recent Runs show the run status, attempts, step summaries, and error messages needed to debug a workflow. A failed run means the automation failed; it does not mean the source artifact write was reverted. ## Create A Hook With MCP [#create-a-hook-with-mcp] MCP users can manage the same hook surface with the hook tool family: * `flywheel_create_hook` * `flywheel_update_hook` * `flywheel_set_hook_enabled` * `flywheel_delete_hook` * `flywheel_list_hooks` * `flywheel_create_hook_secret` * `flywheel_update_hook_secret` * `flywheel_delete_hook_secret` * `flywheel_list_hook_secrets` * `flywheel_list_hook_runs` Use the [MCP tools overview](/mcp/tools) for tool-family orientation and the [generated hook API reference](/api/mcp/mcp_create_hook_v1_nodes__owner_node_id__hooks_post) for exact HTTP/MCP payload details. Your MCP host can also call `flywheel_get_contract` or `flywheel_get_contract_section` for the current contract. ## Generic HTTP Automation [#generic-http-automation] Use `flywheel/http_request@v1` when a finalized artifact or a newly public submission artifact should call an external endpoint. The default HTTP method is `POST`; set `method`, `headers`, `body`, and timeout fields when the endpoint needs them. ```yaml on: artifact.finalized: {} node.published: {} if: all: - any: - event: field: event_type eq: artifact.finalized - event: field: event_type eq: node.published - any_artifact: field: metadata.campaign_role eq: submission jobs: main: steps: - id: call_service uses: flywheel/http_request@v1 with: method: POST url: https://example.invalid/flywheel-hooks/artifact-finalized headers: content-type: application/json authorization: "Bearer ${{ secrets.NAME }}" body: event_id: "${{ event.event_id }}" source_node_id: "${{ event.source_node_id }}" artifact_ids: "${{ event.payload.artifact_ids }}" ``` ## Campaign Submission Automation [#campaign-submission-automation] Campaigns are challenge-style Flywheel graphs where an organizer owns the root, defines the objective and submission contract, and participants do their work in attempt nodes. A common pattern is a root-owned `subtree` hook that reacts to participant submission artifacts. In this pattern, organizer-owned hooks can react to participant submission artifacts without requiring participants to have root-owner permissions. The hook runs under the organizer-owned root and can add review tags, call an external evaluator, or write organizer-owned artifacts without changing participant ownership of the attempt node. For public-policy campaigns, only public attempt nodes can produce valid campaign submission hook events. This example tags an attempt node when a submitted artifact is finalized: ```yaml on: artifact.finalized: {} node.published: {} if: all: - any: - event: field: event_type eq: artifact.finalized - event: field: event_type eq: node.published - any_artifact: field: metadata.campaign_role eq: submission jobs: main: steps: - id: tag_attempt uses: flywheel/add_node_tags@v1 with: node_id: "${{ event.source_node_id }}" tag_ids: - tag-submission-received ``` `flywheel/add_node_tags@v1` is additive: it preserves existing graph tags on the target node and adds the requested existing graph tags. The hook owner must be the root that owns those graph tags. This v1 step does not support one-only tags. This example does not imply Flywheel owns scoring, leaderboard truth, or an external evaluator state machine. Hooks can automate side effects around submitted artifacts, but each campaign should define its own scoring contract and output source. ## Other Workflow Steps [#other-workflow-steps] * `flywheel/http_request@v1`: make one HTTP request and record the response. * `flywheel/http_poll@v1`: poll an HTTP endpoint until the configured success condition or timeout. * `flywheel/json_extract@v1`: extract fields from a previous step response. * `flywheel/load_artifact@v1`: load artifact payload data for later steps. * `flywheel/upsert_artifact@v1`: create or update an artifact selected by `with.match`. * `flywheel/add_node_tags@v1`: add existing graph tags to a target node. For `flywheel/upsert_artifact@v1`, `with.match` is required. Use `match.metadata` for subset matching when artifact IDs are not known ahead of time. Keep selectors unique because ambiguous selectors fail terminally. ## Secrets [#secrets] Hook secrets are scoped to the hook owner node. Create a secret before enabling a hook that references it, rotate it with the update tool when the credential changes, and delete it only after all workflows stop referencing it. Hook secret values are write-only after create or update. Listing secrets returns metadata such as name, version, and timestamps, not plaintext values. Reference a secret from workflow YAML with `${{ secrets.NAME }}`: ```yaml headers: authorization: "Bearer ${{ secrets.NAME }}" ``` ## Troubleshooting Recent Runs [#troubleshooting-recent-runs] Use run history when a hook does not behave as expected: * `queued`: the event matched and the run is waiting for execution. * `running`: the workflow is executing. * `succeeded`: all workflow steps completed. * `failed`: at least one step failed or the workflow configuration was invalid. Inspect attempts, step summaries, outputs, and error messages. Missing secrets, unsupported step types, ambiguous upsert selectors, and non-retryable HTTP statuses are terminal workflow problems. Network failures and retryable HTTP statuses may retry according to the current hook runtime contract. --- # Nodes, Artifacts, And Executions Canonical URL: https://docs.flywheel.paradigma.inc/concepts/nodes-artifacts-executions Nodes hold research work and summary state. Artifacts attach concrete outputs to nodes, including text, tables, JSON, images, plots, checkpoints, and diffs. Executions track managed compute and other run-oriented work associated with a node. These records are separate so graph structure, produced evidence, and compute history can be inspected independently. ## Nodes [#nodes] Use nodes for durable work state: the prompt or task, the hypothesis being tested, the current conclusion, and links to neighboring work. Nodes can be created, branched, committed, merged, tagged, shared, and rendered into compact summaries. Common node commands include: ```bash flywheel nodes:create --title "Evaluate retrieval baseline" flywheel nodes:branch --node_id --title "Try reranker" flywheel nodes:commit --node_id --summary "Current result" ``` ## Artifacts [#artifacts] Use artifacts for evidence. An artifact is the durable output of work: a report, plot, table, dataset excerpt, model checkpoint, patch, transcript, or JSON record. Keeping evidence in artifacts makes it inspectable by people, agents, hooks, and exports without requiring readers to scrape it from prose. Artifact workflows usually follow one of two paths. For ordinary files, use the one-shot upload command. For larger or agent-managed batches, use prepare, upload, and finalize steps so the node records exactly which files landed. ## Executions [#executions] Executions represent run-oriented work tied to a node. Managed compute acquisition, launched jobs, and termination state are separate from artifacts so you can see both the run history and the evidence it produced. Use execution and compute records when an experiment needs external resources, budget approval, or a durable run log. Release compute leases when the work is done so credits are not spent on idle resources. ## How They Fit Together [#how-they-fit-together] A typical empirical branch starts as a node, launches an execution or acquires compute, uploads artifacts from the run, then commits a summary that explains what the artifacts mean. Later branches can cite the same evidence without duplicating it. For command details, see [`nodes:list`](/cli/nodes-list), [`artifacts:list`](/cli/artifacts-list), [`executions:list`](/cli/executions-list), and the [CLI reference](/cli). For guidance on using these records together in research workflows, see [Encoding the Scientific Method](/how-to-use-flywheel/encoding-the-scientific-method). --- # Usage Limits Canonical URL: https://docs.flywheel.paradigma.inc/concepts/usage-limits Flywheel limits high-volume writes per user so one runaway job cannot degrade the service for everyone else. ## Current Write Limits [#current-write-limits] | Write type | Limit | Counts toward it | | ---------------- | ------------------ | ---------------------------------------------------------- | | Node creation | 120 per minute | Creating a new node or branching a node | | Node creation | 2,000 per 24 hours | Creating a new node or branching a node | | Graph writes | 120 per minute | Editing, deleting, merging, tagging, sharing, edge changes | | Graph writes | 2,000 per 24 hours | Editing, deleting, merging, tagging, sharing, edge changes | | Artifact changes | 120 per minute | Finalizing artifacts, deleting artifacts, editing notes | Artifact changes count as graph writes. Hook runs created after artifact finalization do not have a separate user-facing quota. ## Examples [#examples] Creating 100 nodes in one minute is within the node creation limit. Creating 130 nodes in one minute can return a rate-limit response. Creating 2,500 nodes over one day can also return a rate-limit response even if each minute stays under 120 creates. Editing 80 existing nodes and finalizing 30 artifact batches in one minute is 110 graph writes. That is within the graph-write limit. Doing 130 such writes in one minute can return a rate-limit response. Doing 2,500 graph writes over one day can also return a rate-limit response even if each minute stays under 120 graph writes. ## Handling A Limit [#handling-a-limit] When a write is limited, Flywheel returns HTTP `429` with a `Retry-After` header. The response body includes: * `scope`: `node_create` or `graph_write` * `period`: `minute` or `24h` * `limit`: the matching limit * `retry_after_seconds`: how long to wait before retrying Clients and scripts should wait for `Retry-After`, then retry the same idempotent request. For large imports or generated graph work, pace writes in small batches instead of sending thousands of writes at once. --- # account:detach Canonical URL: https://docs.flywheel.paradigma.inc/cli/account-detach {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel account:detach`. ## Command Group [#command-group] Account & Credits Commands ## Summary [#summary] Detach a linked alias account (requires confirm="DETACH"). Requires a browser session; API-key callers receive session\_auth\_required with /app?settings=user. ## Usage [#usage] ```bash flywheel account:detach ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------- | -------- | ------- | ------- | ----------------- | | `--alias_user_id` | `string` | | | Alias user ID. | | `--confirm` | `string` | | | Literal "DETACH". | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Detach. ``` flywheel account:detach --alias_user_id u_abc --confirm DETACH ``` --- # account:emails:add Canonical URL: https://docs.flywheel.paradigma.inc/cli/account-emails-add {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel account:emails:add`. ## Command Group [#command-group] Account & Credits Commands ## Summary [#summary] Add an email alias to your account. Requires a browser session; API-key callers receive session\_auth\_required with /app?settings=user. ## Usage [#usage] ```bash flywheel account:emails:add ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------- | -------- | ------- | ------- | -------------- | | `--email` | `string` | | | Email address. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Add email. ``` flywheel account:emails:add --email alice@example.com ``` --- # account:emails:remove Canonical URL: https://docs.flywheel.paradigma.inc/cli/account-emails-remove {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel account:emails:remove`. ## Command Group [#command-group] Account & Credits Commands ## Summary [#summary] Remove an email alias from your account. Requires a browser session; API-key callers receive session\_auth\_required with /app?settings=user. ## Usage [#usage] ```bash flywheel account:emails:remove ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------- | -------- | ------- | ------- | -------------- | | `--email` | `string` | | | Email address. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Remove email. ``` flywheel account:emails:remove --email alice@example.com ``` --- # account:emails:set-primary Canonical URL: https://docs.flywheel.paradigma.inc/cli/account-emails-set-primary {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel account:emails:set-primary`. ## Command Group [#command-group] Account & Credits Commands ## Summary [#summary] Set your primary email address. Requires a browser session; API-key callers receive session\_auth\_required with /app?settings=user. ## Usage [#usage] ```bash flywheel account:emails:set-primary ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------- | -------- | ------- | ------- | -------------- | | `--email` | `string` | | | Email address. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Set primary. ``` flywheel account:emails:set-primary --email alice@example.com ``` --- # account:get Canonical URL: https://docs.flywheel.paradigma.inc/cli/account-get {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel account:get`. ## Command Group [#command-group] Account & Credits Commands ## Summary [#summary] View account snapshot and linked identities. ## Usage [#usage] ```bash flywheel account:get [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Get account. ``` flywheel account:get ``` --- # account:merge:preview Canonical URL: https://docs.flywheel.paradigma.inc/cli/account-merge-preview {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel account:merge:preview`. ## Command Group [#command-group] Account & Credits Commands ## Summary [#summary] Preview what an account merge will do. Requires a browser session; API-key callers receive session\_auth\_required with /app?settings=user. ## Usage [#usage] ```bash flywheel account:merge:preview ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------- | -------- | ------- | ------- | ------------------ | | `--proof` | `string` | | | Merge proof token. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Preview merge. ``` flywheel account:merge:preview --proof tok ``` --- # account:merge:proof Canonical URL: https://docs.flywheel.paradigma.inc/cli/account-merge-proof {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel account:merge:proof`. ## Command Group [#command-group] Account & Credits Commands ## Summary [#summary] 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. ## Usage [#usage] ```bash flywheel account:merge:proof ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ---------------- | -------- | ------- | ------- | --------------------- | | `--source_token` | `string` | | | Source session token. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Mint proof. ``` flywheel account:merge:proof --source_token tok ``` --- # account:merge Canonical URL: https://docs.flywheel.paradigma.inc/cli/account-merge {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel account:merge`. ## Command Group [#command-group] Account & Credits Commands ## Summary [#summary] Execute an account merge (requires confirm="MERGE"). Requires a browser session; API-key callers receive session\_auth\_required with /app?settings=user. ## Usage [#usage] ```bash flywheel account:merge ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | -------- | ------- | ------- | ------------------ | | `--proof` | `string` | | | Merge proof token. | | `--confirm` | `string` | | | Literal "MERGE". | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Merge accounts. ``` flywheel account:merge --proof tok --confirm MERGE ``` --- # api-keys:create Canonical URL: https://docs.flywheel.paradigma.inc/cli/api-keys-create {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel api-keys:create`. ## Command Group [#command-group] API Keys Commands ## Summary [#summary] Create a new API key and return the raw material once. ## Usage [#usage] ```bash flywheel api-keys:create [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--name` | `string` | | | Human-readable label. | | `--expiry_days` | `integer` | | | Lifetime in days. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Create a 30-day key. ``` flywheel api-keys:create --name ci-bot --expiry_days 30 ``` --- # api-keys:delete Canonical URL: https://docs.flywheel.paradigma.inc/cli/api-keys-delete {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel api-keys:delete`. ## Command Group [#command-group] API Keys Commands ## Summary [#summary] Delete an API key (refuses to delete the active one unless --allow-self). ## Usage [#usage] ```bash flywheel api-keys:delete ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ---------- | -------- | ------- | ------- | -------------- | | `--key_id` | `string` | | | Target key ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Delete a key. ``` flywheel api-keys:delete --key_id k_abc ``` --- # api-keys:list Canonical URL: https://docs.flywheel.paradigma.inc/cli/api-keys-list {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel api-keys:list`. ## Command Group [#command-group] API Keys Commands ## Summary [#summary] List your API keys. ## Usage [#usage] ```bash flywheel api-keys:list [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--limit` | `integer` | | | Maximum keys to return (1..100, default 50). | | `--offset` | `integer` | | | Number of newest keys to skip. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] List the first page of keys. ``` flywheel api-keys:list --limit 50 --offset 0 ``` Return the same page as JSON. ``` flywheel api-keys:list --limit 50 --format=json ``` --- # api-keys:rotate Canonical URL: https://docs.flywheel.paradigma.inc/cli/api-keys-rotate {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel api-keys:rotate`. ## Command Group [#command-group] API Keys Commands ## Summary [#summary] Rotate an API key (refuses to rotate the active one unless --allow-self). ## Usage [#usage] ```bash flywheel api-keys:rotate ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ---------- | -------- | ------- | ------- | -------------- | | `--key_id` | `string` | | | Target key ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--expiry_days` | `integer` | | | Lifetime for the new key. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Rotate a key. ``` flywheel api-keys:rotate --key_id k_abc ``` --- # approval-sessions:expire Canonical URL: https://docs.flywheel.paradigma.inc/cli/approval-sessions-expire {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel approval-sessions:expire`. ## Command Group [#command-group] Approvals & Budgets Commands ## Summary [#summary] Expire an approval session. ## Usage [#usage] ```bash flywheel approval-sessions:expire ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | -------------- | -------- | ------- | ------- | ----------- | | `--session_id` | `string` | | | Session ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Expire. ``` flywheel approval-sessions:expire --session_id s1 ``` --- # approval-sessions:heartbeat Canonical URL: https://docs.flywheel.paradigma.inc/cli/approval-sessions-heartbeat {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel approval-sessions:heartbeat`. ## Command Group [#command-group] Approvals & Budgets Commands ## Summary [#summary] Create or refresh a compute approval session. ## Usage [#usage] ```bash flywheel approval-sessions:heartbeat [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--session_id` | `string` | | | Existing session ID. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Heartbeat. ``` flywheel approval-sessions:heartbeat ``` --- # approval-sessions:list Canonical URL: https://docs.flywheel.paradigma.inc/cli/approval-sessions-list {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel approval-sessions:list`. ## Command Group [#command-group] Approvals & Budgets Commands ## Summary [#summary] List approval sessions. ## Usage [#usage] ```bash flywheel approval-sessions:list [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--status` | `string` | | | active \| expired. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] List active sessions. ``` flywheel approval-sessions:list --status active ``` --- # artifacts:delete-bulk Canonical URL: https://docs.flywheel.paradigma.inc/cli/artifacts-delete-bulk {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel artifacts:delete-bulk`. ## Command Group [#command-group] Artifacts & Files Commands ## Summary [#summary] Delete multiple artifacts from one node. ## Usage [#usage] ```bash flywheel artifacts:delete-bulk ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------------------- | --------- | ------- | ------- | ----------------------------- | | `--node_id` | `string` | | | Owning node. | | `--artifact_ids` | `string` | | | Comma-separated artifact IDs. | | `--expected_revision` | `integer` | | | Optimistic lock. | | `--yes` | | | | Confirm destructive deletion. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Delete multiple artifacts. ``` flywheel artifacts:delete-bulk --node_id n --artifact_ids a,b --expected_revision 7 --yes ``` --- # artifacts:delete Canonical URL: https://docs.flywheel.paradigma.inc/cli/artifacts-delete {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel artifacts:delete`. ## Command Group [#command-group] Artifacts & Files Commands ## Summary [#summary] Delete an artifact from a node. ## Usage [#usage] ```bash flywheel artifacts:delete ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------------------- | --------- | ------- | ------- | ---------------- | | `--node_id` | `string` | | | Owning node. | | `--artifact_id` | `string` | | | Artifact ID. | | `--expected_revision` | `integer` | | | Optimistic lock. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Delete an artifact. ``` flywheel artifacts:delete --node_id n --artifact_id a --expected_revision 7 ``` --- # artifacts:get Canonical URL: https://docs.flywheel.paradigma.inc/cli/artifacts-get {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel artifacts:get`. ## Command Group [#command-group] Artifacts & Files Commands ## Summary [#summary] Fetch one artifact metadata record. ## Usage [#usage] ```bash flywheel artifacts:get ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------------- | -------- | ------- | ------- | --------------------------- | | `--node_id` | `string` | | | Owning node identifier. | | `--artifact_id` | `string` | | | Target artifact identifier. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Fetch an artifact metadata record. ``` flywheel artifacts:get --node_id n_abc --artifact_id art_42 ``` Fetch an artifact metadata record using --key=value form. ``` flywheel artifacts:get --node_id=n_abc --artifact_id=art_42 --format=json ``` --- # artifacts:list Canonical URL: https://docs.flywheel.paradigma.inc/cli/artifacts-list {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel artifacts:list`. ## Command Group [#command-group] Artifacts & Files Commands ## Summary [#summary] List artifacts for a node. ## Usage [#usage] ```bash flywheel artifacts:list ``` ## Aliases [#aliases] `arl` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | -------- | ------- | ------- | ----------------------- | | `--node_id` | `string` | | | Owning node identifier. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--limit` | `integer` | | | Maximum artifacts to return. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] List up to 10 artifacts on a node. ``` flywheel artifacts:list --node_id n_abc --limit 10 ``` List artifacts with TSV output for downstream tooling. ``` flywheel artifacts:list --node_id=n_abc --format=tsv ``` --- # artifacts:note:set Canonical URL: https://docs.flywheel.paradigma.inc/cli/artifacts-note-set {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel artifacts:note:set`. ## Command Group [#command-group] Artifacts & Files Commands ## Summary [#summary] Add, update, or clear an artifact note. ## Usage [#usage] ```bash flywheel artifacts:note:set ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------------------- | --------- | ------- | ------- | ---------------- | | `--node_id` | `string` | | | Owning node. | | `--artifact_id` | `string` | | | Artifact ID. | | `--expected_revision` | `integer` | | | Optimistic lock. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--note` | `string` | | | Note text (omit to clear). | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Attach a note. ``` flywheel artifacts:note:set --node_id n --artifact_id a --expected_revision 7 --note "needs review" ``` --- # artifacts:upload:finalize Canonical URL: https://docs.flywheel.paradigma.inc/cli/artifacts-upload-finalize {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel artifacts:upload:finalize`. ## Command Group [#command-group] Artifacts & Files Commands ## Summary [#summary] Finalize prepared artifact uploads and attach artifacts. ## Usage [#usage] ```bash flywheel artifacts:upload:finalize ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------------- | -------- | ------- | ------- | ---------------------------- | | `--node_id` | `string` | | | Owning node. | | `--batch_token` | `string` | | | Token returned from prepare. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Finalize batch. ``` flywheel artifacts:upload:finalize --node_id n --batch_token tok_abc ``` --- # artifacts:upload:prepare Canonical URL: https://docs.flywheel.paradigma.inc/cli/artifacts-upload-prepare {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel artifacts:upload:prepare`. ## Command Group [#command-group] Artifacts & Files Commands ## Summary [#summary] Create upload batch with signed per-item upload tickets. ## Usage [#usage] ```bash flywheel artifacts:upload:prepare ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------------------- | --------- | ------- | ------- | --------------------------- | | `--node_id` | `string` | | | Owning node. | | `--expected_revision` | `integer` | | | Optimistic lock. | | `--items` | `json` | | | JSON array of upload items. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Prepare one upload. ``` flywheel artifacts:upload:prepare --node_id n --expected_revision 3 --items '[{"local_path":"report.pdf"}]' ``` --- # artifacts:upload Canonical URL: https://docs.flywheel.paradigma.inc/cli/artifacts-upload {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel artifacts:upload`. ## Command Group [#command-group] Artifacts & Files Commands ## Summary [#summary] One-shot upload: prepare + PUT + finalize from a single invocation. ## Usage [#usage] ```bash flywheel artifacts:upload ``` ## Aliases [#aliases] `aru` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------------------- | --------- | ------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--node_id` | `string` | | | Owning node. | | `--expected_revision` | `integer` | | | Optimistic lock. | | `--items` | `json` | | | Upload item JSON array. Supports inline JSON, @file paths, @- stdin, and @@ literal escaping. Each item requires local\_path and artifact\_type (one of: text, table, json, image, banner, html, plotly\_html, vega, checkpoint, binary, diff\_carousel); optional media\_type, title, execution\_id, note, metadata. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Upload a file. ``` flywheel artifacts:upload --node_id n --expected_revision 3 --items '[{"local_path":"./report.pdf","artifact_type":"binary"}]' ``` Upload items from a JSON file. ``` flywheel artifacts:upload --node_id n --expected_revision 3 --items=@./items.json ``` Read upload items JSON from stdin. ``` cat items.json | flywheel artifacts:upload --node_id n --expected_revision 3 --items=@- ``` Escape a literal JSON value that begins with @. ``` flywheel artifacts:upload --node_id n --expected_revision 3 --items=@@[{"local_path":"./report.pdf","artifact_type":"binary"}] ``` --- # auth:keychain:clear Canonical URL: https://docs.flywheel.paradigma.inc/cli/auth-keychain-clear {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel auth:keychain:clear`. ## Command Group [#command-group] Auth Commands ## Summary [#summary] Remove an API key from the OS keychain for a profile. ## Usage [#usage] ```bash flywheel auth:keychain:clear [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--profile` | `string` | | | Profile name (default "default"). | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Clear stored key. ``` flywheel auth:keychain:clear --profile prod ``` --- # auth:keychain:set Canonical URL: https://docs.flywheel.paradigma.inc/cli/auth-keychain-set {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel auth:keychain:set`. ## Command Group [#command-group] Auth Commands ## Summary [#summary] Store an API key in the OS keychain for a profile. Reads the key from stdin. ## Usage [#usage] ```bash flywheel auth:keychain:set [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--profile` | `string` | | | Profile name (default "default"). | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Store key via stdin. ``` echo -n $KEY | flywheel auth:keychain:set --profile prod ``` --- # auth:login Canonical URL: https://docs.flywheel.paradigma.inc/cli/auth-login {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel auth:login`. ## Command Group [#command-group] Auth Commands ## Summary [#summary] Bootstrap API key auth through RFC 8628 device authorization flow. ## Usage [#usage] ```bash flywheel auth:login [FLAGS] ``` ## Aliases [#aliases] `al` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--name` | `string` | | | Human-readable label for the new key. | | `--expiry_days` | `integer` | | | Key lifetime in days (server default applies when omitted). | | `--no-browser` | | | | Print the verification URL instead of auto-opening the browser. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Interactive login against the active profile. ``` flywheel auth:login ``` Headless login (prints the verification URL instead of opening the browser). ``` flywheel auth:login --no-browser ``` --- # auth:status Canonical URL: https://docs.flywheel.paradigma.inc/cli/auth-status {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel auth:status`. ## Command Group [#command-group] Auth Commands ## Summary [#summary] Show authentication status for the current client context. ## Usage [#usage] ```bash flywheel auth:status [FLAGS] ``` ## Aliases [#aliases] `as` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Check whether the current config is authenticated. ``` flywheel auth:status --format=json ``` Produce tab-separated output for script consumption. ``` flywheel auth:status --format=tsv ``` --- # blobs:get Canonical URL: https://docs.flywheel.paradigma.inc/cli/blobs-get {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel blobs:get`. ## Command Group [#command-group] Updates & Resources Commands ## Summary [#summary] Download a raw blob by storage key. ## Usage [#usage] ```bash flywheel blobs:get ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ------- | -------- | ------- | ------- | ------------ | | `--key` | `string` | | | Storage key. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Fetch a blob. ``` flywheel blobs:get --key blob_abc --out=./out.bin ``` --- # campaign-budgets:create Canonical URL: https://docs.flywheel.paradigma.inc/cli/campaign-budgets-create {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel campaign-budgets:create`. ## Command Group [#command-group] Approvals & Budgets Commands ## Summary [#summary] Create a campaign compute budget grant. ## Usage [#usage] ```bash flywheel campaign-budgets:create ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ------------------ | --------- | ------- | ------- | ------------------ | | `--root_node_id` | `string` | | | Graph root ID. | | `--hard_cap_cents` | `integer` | | | Hard cap in cents. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--label` | `string` | | | Label. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Create a budget. ``` flywheel campaign-budgets:create --root_node_id r_root --hard_cap_cents 10000 ``` --- # campaign-budgets:list Canonical URL: https://docs.flywheel.paradigma.inc/cli/campaign-budgets-list {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel campaign-budgets:list`. ## Command Group [#command-group] Approvals & Budgets Commands ## Summary [#summary] List campaign compute budgets for a root. ## Usage [#usage] ```bash flywheel campaign-budgets:list ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ---------------- | -------- | ------- | ------- | -------------- | | `--root_node_id` | `string` | | | Graph root ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] List budgets. ``` flywheel campaign-budgets:list --root_node_id r_root ``` --- # campaign-budgets:revoke Canonical URL: https://docs.flywheel.paradigma.inc/cli/campaign-budgets-revoke {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel campaign-budgets:revoke`. ## Command Group [#command-group] Approvals & Budgets Commands ## Summary [#summary] Revoke a campaign budget grant. ## Usage [#usage] ```bash flywheel campaign-budgets:revoke ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------------------- | -------- | ------- | ------- | -------------- | | `--root_node_id` | `string` | | | Graph root ID. | | `--compute_budget_id` | `string` | | | Budget ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Revoke. ``` flywheel campaign-budgets:revoke --root_node_id r --compute_budget_id b ``` --- # campaign-budgets:update Canonical URL: https://docs.flywheel.paradigma.inc/cli/campaign-budgets-update {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel campaign-budgets:update`. ## Command Group [#command-group] Approvals & Budgets Commands ## Summary [#summary] Update a campaign budget. ## Usage [#usage] ```bash flywheel campaign-budgets:update ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------------------- | -------- | ------- | ------- | -------------- | | `--root_node_id` | `string` | | | Graph root ID. | | `--compute_budget_id` | `string` | | | Budget ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | --------------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--hard_cap_cents` | `integer` | | | Hard cap in cents. | | `--per_user_hard_cap_cents` | `integer` | | | Optional per-user hard cap in cents. | | `--name` | `string` | | | Budget name. | | `--description` | `string` | | | Budget description. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Bump hard cap. ``` flywheel campaign-budgets:update --root_node_id r --compute_budget_id b --hard_cap_cents 20000 ``` --- # campaign:snapshot Canonical URL: https://docs.flywheel.paradigma.inc/cli/campaign-snapshot {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel campaign:snapshot`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Resolve campaign root snapshot for a node. ## Usage [#usage] ```bash flywheel campaign:snapshot ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | -------- | ------- | ------- | ----------- | | `--node_id` | `string` | | | Node ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Read campaign snapshot. ``` flywheel campaign:snapshot --node_id n_abc ``` --- # completion bash Canonical URL: https://docs.flywheel.paradigma.inc/cli/completion-bash {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel completion bash`. ## Command Group [#command-group] Setup Commands ## Summary [#summary] Generate a bash shell completion script ## Usage [#usage] ```bash flywheel completion bash [--include-bash-completion-lib] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------------------- | ----- | ------- | ------- | ------------------------------------------------------ | | `--include-bash-completion-lib` | | | | Include Usage's bash completion library in bash output | ## Examples [#examples] Generate bash completions ``` flywheel completion bash ``` --- # completion fish Canonical URL: https://docs.flywheel.paradigma.inc/cli/completion-fish {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel completion fish`. ## Command Group [#command-group] Setup Commands ## Summary [#summary] Generate a fish shell completion script ## Usage [#usage] ```bash flywheel completion fish ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] None. ## Examples [#examples] Generate fish completions ``` flywheel completion fish ``` --- # completion install Canonical URL: https://docs.flywheel.paradigma.inc/cli/completion-install {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel completion install`. This command writes Flywheel-managed completion files for the selected shell so future CLI updates can replace them cleanly. ## Command Group [#command-group] Setup Commands ## Summary [#summary] Install a generated shell completion script to a user-level location ## Usage [#usage] ```bash flywheel completion install [FLAGS] ``` ## Arguments [#arguments] | Argument | Required | Choices | Description | | --------- | -------- | ---------------------------------------------------- | -------------------------------- | | `` | Yes | `bash`, `zsh`, `fish`, `powershell`, `nu`, `nushell` | Shell to install completions for | ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------ | ------ | ------- | ------- | ------------------------------------------------ | | `--dir` | `path` | | | Override completion script destination directory | | `--force` | | | | Replace an existing unmarked destination file | | `--dry-run` | | | | Print planned changes without writing files | | `--update-profile` | | | | Allow shell startup/profile file updates | | `-y, --yes` | | | | Skip confirmation prompts | ## Examples [#examples] Install bash completions ``` flywheel completion install bash ``` Install zsh completions and update the profile ``` flywheel completion install zsh --update-profile --yes ``` Preview Nushell completion installation ``` flywheel completion install nushell --dry-run ``` --- # completion nu Canonical URL: https://docs.flywheel.paradigma.inc/cli/completion-nu {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel completion nu`. ## Command Group [#command-group] Setup Commands ## Summary [#summary] Generate a nu shell completion script ## Usage [#usage] ```bash flywheel completion nu ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] None. ## Examples [#examples] Generate nu completions ``` flywheel completion nu ``` --- # completion nushell Canonical URL: https://docs.flywheel.paradigma.inc/cli/completion-nushell {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel completion nushell`. ## Command Group [#command-group] Setup Commands ## Summary [#summary] Generate a nushell shell completion script ## Usage [#usage] ```bash flywheel completion nushell ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] None. ## Examples [#examples] Generate nushell completions ``` flywheel completion nushell ``` --- # completion powershell Canonical URL: https://docs.flywheel.paradigma.inc/cli/completion-powershell {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel completion powershell`. ## Command Group [#command-group] Setup Commands ## Summary [#summary] Generate a powershell shell completion script ## Usage [#usage] ```bash flywheel completion powershell ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] None. ## Examples [#examples] Generate powershell completions ``` flywheel completion powershell ``` --- # completion uninstall Canonical URL: https://docs.flywheel.paradigma.inc/cli/completion-uninstall {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel completion uninstall`. ## Command Group [#command-group] Setup Commands ## Summary [#summary] Remove Flywheel-managed shell completion files and profile blocks ## Usage [#usage] ```bash flywheel completion uninstall [FLAGS] ``` ## Arguments [#arguments] | Argument | Required | Choices | Description | | --------- | -------- | ---------------------------------------------------- | ---------------------------------- | | `` | Yes | `bash`, `zsh`, `fish`, `powershell`, `nu`, `nushell` | Shell to uninstall completions for | ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------ | ------ | ------- | ------- | ------------------------------------------------ | | `--dir` | `path` | | | Override completion script destination directory | | `--dry-run` | | | | Print planned removals without writing files | | `--update-profile` | | | | Allow shell startup/profile file updates | | `-y, --yes` | | | | Skip confirmation prompts | ## Examples [#examples] Uninstall zsh completions and profile wiring ``` flywheel completion uninstall zsh --update-profile --yes ``` Preview fish completion uninstall ``` flywheel completion uninstall fish --dry-run ``` --- # completion zsh Canonical URL: https://docs.flywheel.paradigma.inc/cli/completion-zsh {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel completion zsh`. ## Command Group [#command-group] Setup Commands ## Summary [#summary] Generate a zsh shell completion script ## Usage [#usage] ```bash flywheel completion zsh ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] None. ## Examples [#examples] Generate zsh completions ``` flywheel completion zsh ``` --- # completion Canonical URL: https://docs.flywheel.paradigma.inc/cli/completion {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel completion`. ## Command Group [#command-group] Setup Commands ## Summary [#summary] Generate a shell completion script from the public Flywheel Usage spec ## Usage [#usage] ```bash flywheel completion [--include-bash-completion-lib] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------------------- | ----- | ------- | ------- | ------------------------------------------------------ | | `--include-bash-completion-lib` | | | | Include Usage's bash completion library in bash output | ## Examples [#examples] Generate bash completions ``` flywheel completion bash ``` Generate zsh completions ``` flywheel completion zsh ``` Generate Nushell completions with the alias ``` flywheel completion nushell ``` ## Subcommands [#subcommands] | Command | Summary | | -------------------------------------------------------------- | -------------------------------------------------------------------- | | [`flywheel completion bash`](/cli/completion-bash) | Generate a bash shell completion script | | [`flywheel completion zsh`](/cli/completion-zsh) | Generate a zsh shell completion script | | [`flywheel completion fish`](/cli/completion-fish) | Generate a fish shell completion script | | [`flywheel completion powershell`](/cli/completion-powershell) | Generate a powershell shell completion script | | [`flywheel completion nu`](/cli/completion-nu) | Generate a nu shell completion script | | [`flywheel completion nushell`](/cli/completion-nushell) | Generate a nushell shell completion script | | [`flywheel completion install`](/cli/completion-install) | Install a generated shell completion script to a user-level location | | [`flywheel completion uninstall`](/cli/completion-uninstall) | Remove Flywheel-managed shell completion files and profile blocks | --- # compute:acquire Canonical URL: https://docs.flywheel.paradigma.inc/cli/compute-acquire {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel compute:acquire`. ## Command Group [#command-group] Compute & Executions Commands ## Summary [#summary] Acquire managed compute for a node; with --wait, wait for usable SSH connection material. ## Usage [#usage] ```bash flywheel compute:acquire ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------------- | -------- | ------- | ------- | -------------------------------------------------------------- | | `--node_id` | `string` | | | Target node. | | `--compute_grant_id` | `string` | | | Bound grant ID. | | `--requested_sku` | `string` | | | SKU. | | `--approval_session_id` | `string` | | | Approval session ID (server requires; see compute-acquire.ts). | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | ---------------------------------------------------------------------------------------------- | | `--region` | `string` | | | Region. Optional for provider-validated offers; required otherwise (server decides per-offer). | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Acquire. ``` flywheel compute:acquire --node_id n --compute_grant_id g --requested_sku sku --region us-east ``` --- # compute:budgets Canonical URL: https://docs.flywheel.paradigma.inc/cli/compute-budgets {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel compute:budgets`. ## Command Group [#command-group] Compute & Executions Commands ## Summary [#summary] List budget grants visible for a node context. ## Usage [#usage] ```bash flywheel compute:budgets ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | -------- | ------- | ------- | ----------- | | `--node_id` | `string` | | | Node ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--budget_source` | `string` | | | Filter by source: user \| root. | | `--status` | `string` | | | Filter by status. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] List budgets. ``` flywheel compute:budgets --node_id n_abc ``` --- # compute:connection Canonical URL: https://docs.flywheel.paradigma.inc/cli/compute-connection {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel compute:connection`. ## Command Group [#command-group] Compute & Executions Commands ## Summary [#summary] Get SSH connection material for a usable lease. ## Usage [#usage] ```bash flywheel compute:connection ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------------- | -------- | ------- | ------- | -------------------- | | `--lease_control_token` | `string` | | | Lease control token. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--lease_id` | `string` | | | Target lease ID. | | `--node_id` | `string` | | | Target node ID. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Get connection. ``` flywheel compute:connection --lease_control_token tok --lease_id l1 ``` --- # compute:funding Canonical URL: https://docs.flywheel.paradigma.inc/cli/compute-funding {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel compute:funding`. ## Command Group [#command-group] Compute & Executions Commands ## Summary [#summary] Read grant-scoped funding context before compute acquire. ## Usage [#usage] ```bash flywheel compute:funding ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | -------------------- | -------- | ------- | ------- | ----------- | | `--compute_grant_id` | `string` | | | Grant ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ----------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--approval_session_id` | `string` | | | Approval session ID. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Read funding. ``` flywheel compute:funding --compute_grant_id g_abc ``` --- # compute-grants:list Canonical URL: https://docs.flywheel.paradigma.inc/cli/compute-grants-list {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel compute-grants:list`. ## Command Group [#command-group] Other Commands ## Summary [#summary] List compute grants available to the user. ## Usage [#usage] ```bash flywheel compute-grants:list [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ----------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--budget_source` | `string` | | | user \| root. | | `--status` | `string` | | | active \| expired. | | `--approval_session_id` | `string` | | | Scope to approval session. | | `--limit` | `integer` | | | Maximum grants to return. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] List grants. ``` flywheel compute-grants:list --budget_source user --status active ``` --- # compute-grants:request-approval Canonical URL: https://docs.flywheel.paradigma.inc/cli/compute-grants-request-approval {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel compute-grants:request-approval`. ## Command Group [#command-group] Other Commands ## Summary [#summary] Request compute-grant approval. POSTs to the consolidated server endpoint which owns the heartbeat/grants/credits/campaign-budgets/status fan-out. ## Usage [#usage] ```bash flywheel compute-grants:request-approval ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------- | -------- | ------- | ------- | ----------------------- | | `--purpose` | `string` | | | Human-readable purpose. | | `--requested_sku` | `string` | | | SKU. | | `--budget_source` | `string` | | | user \| root. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ---------------------------- | --------- | ------- | ----------------------------- | ---------------------------------------------------------------------------------------------- | | `--region` | `string` | | | Region. Optional for provider-validated offers; required otherwise (server decides per-offer). | | `--acquire_node_id` | `string` | | | Target node for acquire. | | `--approval_session_id` | `string` | | | Existing approval session to reuse. | | `--lease_control_token` | `string` | | | Triggers optional status preflight when set. | | `--grant_action` | `string` | | | create \| top\_up. | | `--compute_budget_id` | `string` | | | Budget identifier for grant allocation. | | `--target_compute_grant_id` | `string` | | | Existing grant to top up. | | `--provider` | `string` | | | Compute provider hint. | | `--suggested_hard_cap_cents` | `integer` | | | Suggested grant hard cap in cents. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Request approval. ``` flywheel compute-grants:request-approval --purpose "train" --requested_sku sku --region us-east --budget_source user ``` --- # compute:options Canonical URL: https://docs.flywheel.paradigma.inc/cli/compute-options {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel compute:options`. ## Command Group [#command-group] Compute & Executions Commands ## Summary [#summary] List allowed compute catalog options for a node. ## Usage [#usage] ```bash flywheel compute:options ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | -------- | ------- | ------- | ---------------------------- | | `--node_id` | `string` | | | Node ID for contract compat. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--provider` | `string` | | | Filter by provider. | | `--limit` | `integer` | | | Max entries. | | `--detail` | `string` | | | compact \| full. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] List catalog. ``` flywheel compute:options --node_id n_abc --detail compact ``` --- # compute:release-all Canonical URL: https://docs.flywheel.paradigma.inc/cli/compute-release-all {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel compute:release-all`. ## Command Group [#command-group] Compute & Executions Commands ## Summary [#summary] Release all active leases in current scope (pass --force for account scope). ## Usage [#usage] ```bash flywheel compute:release-all ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------------- | -------- | ------- | ------- | -------------------- | | `--lease_control_token` | `string` | | | Lease control token. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Release all (default token scope). ``` flywheel compute:release-all --lease_control_token tok ``` Force release all releasable leases with explicit token scope. ``` flywheel compute:release-all --lease_control_token tok --force --yes ``` --- # compute:release Canonical URL: https://docs.flywheel.paradigma.inc/cli/compute-release {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel compute:release`. ## Command Group [#command-group] Compute & Executions Commands ## Summary [#summary] Release one active compute lease (async; use --wait to block). ## Usage [#usage] ```bash flywheel compute:release ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------------- | -------- | ------- | ------- | -------------------- | | `--lease_id` | `string` | | | Lease ID. | | `--lease_control_token` | `string` | | | Lease control token. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Release a lease. ``` flywheel compute:release --lease_id l1 --lease_control_token tok ``` --- # compute:status Canonical URL: https://docs.flywheel.paradigma.inc/cli/compute-status {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel compute:status`. ## Command Group [#command-group] Compute & Executions Commands ## Summary [#summary] Return compute lease status. ## Usage [#usage] ```bash flywheel compute:status ``` ## Aliases [#aliases] `cs` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------------- | -------- | ------- | ------- | ---------------------------------------------------- | | `--lease_control_token` | `string` | | | Lease control token issued by the compute subsystem. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | -------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--provider` | `string` | | | Compute provider filter. | | `--compute_grant_id` | `string` | | | Scope status to a compute grant. | | `--limit` | `integer` | | | Maximum number of status records to return. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Check the status of a lease by control token. ``` flywheel compute:status --lease_control_token tok_42 ``` Emit compute status as TSV for scripted monitoring. ``` flywheel compute:status --lease_control_token=tok_42 --limit=20 --format=tsv ``` --- # credits:balance Canonical URL: https://docs.flywheel.paradigma.inc/cli/credits-balance {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel credits:balance`. ## Command Group [#command-group] Account & Credits Commands ## Summary [#summary] View credit balance and totals. ## Usage [#usage] ```bash flywheel credits:balance [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Check balance. ``` flywheel credits:balance ``` --- # credits:billing-portal Canonical URL: https://docs.flywheel.paradigma.inc/cli/credits-billing-portal {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel credits:billing-portal`. ## Command Group [#command-group] Account & Credits Commands ## Summary [#summary] Open the Stripe billing portal for the current user and return browser\_flow\_required JSON with url, opened, and next\_action. ## Usage [#usage] ```bash flywheel credits:billing-portal [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Open billing settings in the browser. After completing the browser flow, verify with flywheel credits:balance, credits:transactions, or credits:subscription. ``` flywheel credits:billing-portal ``` --- # credits:purchase Canonical URL: https://docs.flywheel.paradigma.inc/cli/credits-purchase {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel credits:purchase`. ## Command Group [#command-group] Account & Credits Commands ## Summary [#summary] Create a Stripe checkout session for a one-time purchase and return browser\_flow\_required JSON with url, opened, and next\_action. ## Usage [#usage] ```bash flywheel credits:purchase ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ---------------- | --------- | ------- | ------- | ------------------------- | | `--amount_cents` | `integer` | | | Purchase amount in cents. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Buy 25.00 of credit. After completing the browser flow, verify with flywheel credits:balance, credits:transactions, or credits:subscription. ``` flywheel credits:purchase --amount_cents 2500 ``` --- # credits:referral:claim Canonical URL: https://docs.flywheel.paradigma.inc/cli/credits-referral-claim {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel credits:referral:claim`. ## Command Group [#command-group] Account & Credits Commands ## Summary [#summary] Claim referral rewards using a code. ## Usage [#usage] ```bash flywheel credits:referral:claim ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | -------- | -------- | ------- | ------- | -------------- | | `--code` | `string` | | | Referral code. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Claim. ``` flywheel credits:referral:claim --code ABC123 ``` --- # credits:referral Canonical URL: https://docs.flywheel.paradigma.inc/cli/credits-referral {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel credits:referral`. ## Command Group [#command-group] Account & Credits Commands ## Summary [#summary] View your referral code and status. ## Usage [#usage] ```bash flywheel credits:referral [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Referral. ``` flywheel credits:referral ``` --- # credits:subscribe Canonical URL: https://docs.flywheel.paradigma.inc/cli/credits-subscribe {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel credits:subscribe`. ## Command Group [#command-group] Account & Credits Commands ## Summary [#summary] Create a Stripe checkout session for a subscription and return browser\_flow\_required JSON with url, opened, and next\_action. ## Usage [#usage] ```bash flywheel credits:subscribe [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | -------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--billing_interval` | `string` | | | monthly \| yearly. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Subscribe. After completing the browser flow, verify with flywheel credits:balance, credits:transactions, or credits:subscription. ``` flywheel credits:subscribe --billing_interval monthly ``` --- # credits:subscription Canonical URL: https://docs.flywheel.paradigma.inc/cli/credits-subscription {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel credits:subscription`. ## Command Group [#command-group] Account & Credits Commands ## Summary [#summary] View your subscription status. ## Usage [#usage] ```bash flywheel credits:subscription [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Subscription. ``` flywheel credits:subscription ``` --- # credits:transactions Canonical URL: https://docs.flywheel.paradigma.inc/cli/credits-transactions {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel credits:transactions`. ## Command Group [#command-group] Account & Credits Commands ## Summary [#summary] View paginated credit transactions. ## Usage [#usage] ```bash flywheel credits:transactions [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--limit` | `integer` | | | Max rows. | | `--offset` | `integer` | | | Offset. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] List transactions. ``` flywheel credits:transactions --limit 50 ``` --- # credits:usage Canonical URL: https://docs.flywheel.paradigma.inc/cli/credits-usage {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel credits:usage`. ## Command Group [#command-group] Account & Credits Commands ## Summary [#summary] Feature-based usage breakdown over a window. ## Usage [#usage] ```bash flywheel credits:usage [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--days` | `integer` | | | Trailing window (days). | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Last 30 days. ``` flywheel credits:usage --days 30 ``` --- # executions:launch Canonical URL: https://docs.flywheel.paradigma.inc/cli/executions-launch {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel executions:launch`. ## Command Group [#command-group] Compute & Executions Commands ## Summary [#summary] Start an execution for a node. ## Usage [#usage] ```bash flywheel executions:launch ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------------------- | --------- | ------- | ------- | ---------------- | | `--node_id` | `string` | | | Target node. | | `--expected_revision` | `integer` | | | Optimistic lock. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--provider` | `string` | | | Compute provider name. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Launch an execution. ``` flywheel executions:launch --node_id n_abc --expected_revision 5 ``` --- # executions:list Canonical URL: https://docs.flywheel.paradigma.inc/cli/executions-list {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel executions:list`. ## Command Group [#command-group] Compute & Executions Commands ## Summary [#summary] List executions for a node. ## Usage [#usage] ```bash flywheel executions:list ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | -------- | ------- | ------- | ----------- | | `--node_id` | `string` | | | Node ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] List. ``` flywheel executions:list --node_id n_abc ``` --- # executions:terminate Canonical URL: https://docs.flywheel.paradigma.inc/cli/executions-terminate {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel executions:terminate`. ## Command Group [#command-group] Compute & Executions Commands ## Summary [#summary] Stop an execution for a node. ## Usage [#usage] ```bash flywheel executions:terminate ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------------------- | --------- | ------- | ------- | ---------------- | | `--node_id` | `string` | | | Node ID. | | `--execution_id` | `string` | | | Execution ID. | | `--expected_revision` | `integer` | | | Optimistic lock. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Terminate. ``` flywheel executions:terminate --node_id n_abc --execution_id e1 --expected_revision 6 ``` --- # export:history Canonical URL: https://docs.flywheel.paradigma.inc/cli/export-history {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel export:history`. ## Command Group [#command-group] Export & Import Commands ## Summary [#summary] Export node history as JSONL. ## Usage [#usage] ```bash flywheel export:history [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Export. ``` flywheel export:history --out=./history.jsonl ``` --- # export:subgraph Canonical URL: https://docs.flywheel.paradigma.inc/cli/export-subgraph {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel export:subgraph`. ## Command Group [#command-group] Export & Import Commands ## Summary [#summary] Export a subgraph snapshot. ## Usage [#usage] ```bash flywheel export:subgraph ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ------------ | -------- | ------- | ------- | -------------------------------------------------------------------- | | `--node_ids` | `string` | | | Comma-separated list of node identifiers to include in the snapshot. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ----------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--include_descendants` | | | | When true, expand each requested node to all visible descendants. | | `--max_nodes` | `integer` | | | Maximum nodes allowed after expansion (default 500, upper bound 5000). | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Export a root and all visible descendants. ``` flywheel export:subgraph --node_ids n_abc --include_descendants true --max_nodes 500 ``` Export a single-node subgraph snapshot as CSV. ``` flywheel export:subgraph --node_ids=n_abc --format=csv ``` --- # export:summary:pdf Canonical URL: https://docs.flywheel.paradigma.inc/cli/export-summary-pdf {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel export:summary:pdf`. ## Command Group [#command-group] Export & Import Commands ## Summary [#summary] Render summary as PDF; requires --out. ## Usage [#usage] ```bash flywheel export:summary:pdf ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ------------ | -------- | ------- | ------- | ------------------------- | | `--node_ids` | `string` | | | Comma-separated node IDs. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Render PDF. ``` flywheel export:summary:pdf --node_ids n1 --out=./summary.pdf ``` --- # export:summary:render-pdf Canonical URL: https://docs.flywheel.paradigma.inc/cli/export-summary-render-pdf {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel export:summary:render-pdf`. ## Command Group [#command-group] Export & Import Commands ## Summary [#summary] Render caller-provided markdown as PDF; requires --out. ## Usage [#usage] ```bash flywheel export:summary:render-pdf ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ------------ | -------- | ------- | ------- | ------------------------------ | | `--node_ids` | `string` | | | Comma-separated node IDs. | | `--title` | `string` | | | PDF title. | | `--markdown` | `string` | | | Inline markdown or @file path. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Render supplied markdown. ``` flywheel export:summary:render-pdf --node_ids n1 --title "Summary" --markdown=@doc.md --out=./doc.pdf ``` --- # export:summary:stream Canonical URL: https://docs.flywheel.paradigma.inc/cli/export-summary-stream {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel export:summary:stream`. ## Command Group [#command-group] Export & Import Commands ## Summary [#summary] Stream summary generation as NDJSON events. ## Usage [#usage] ```bash flywheel export:summary:stream ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ------------ | -------- | ------- | ------- | ------------------------- | | `--node_ids` | `string` | | | Comma-separated node IDs. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Stream summary events. ``` flywheel export:summary:stream --node_ids n1,n2 ``` --- # export:summary Canonical URL: https://docs.flywheel.paradigma.inc/cli/export-summary {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel export:summary`. ## Command Group [#command-group] Export & Import Commands ## Summary [#summary] Generate a markdown summary export. ## Usage [#usage] ```bash flywheel export:summary ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ------------ | -------- | ------- | ------- | ------------------------- | | `--node_ids` | `string` | | | Comma-separated node IDs. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Export summary. ``` flywheel export:summary --node_ids n1,n2 ``` --- # feedback:create Canonical URL: https://docs.flywheel.paradigma.inc/cli/feedback-create {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel feedback:create`. ## Command Group [#command-group] Other Commands ## Summary [#summary] Submit bounded feedback to the Flywheel team. ## Usage [#usage] ```bash flywheel feedback:create ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | -------- | ------- | ------- | -------------- | | `--message` | `string` | | | Feedback text. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------------ | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--category` | `string` | | | Feedback category. | | `--severity` | `string` | | | Feedback severity. | | `--route_family` | `string` | | | Bounded route family associated with the feedback. | | `--node_workflow_family` | `string` | | | Bounded node workflow family associated with the feedback. | | `--command_family` | `string` | | | CLI command family. | | `--tool_family` | `string` | | | MCP tool family associated with the feedback. | | `--node_id` | `string` | | | Related node ID. | | `--request_id` | `string` | | | Related request ID. | | `--trace_id` | `string` | | | Related trace ID. | | `--sentry_event_id` | `string` | | | Related Sentry event ID. | | `--product_event_id` | `string` | | | Related product event ID. | | `--cli_invocation_id` | `string` | | | Related CLI invocation ID. | | `--mcp_request_id` | `string` | | | Related MCP request ID. | | `--mcp_idempotency_key` | `string` | | | Related MCP idempotency key. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Submit CLI feedback. ``` flywheel feedback:create --message "The node command is confusing" --category confusing --severity medium ``` --- # files:list Canonical URL: https://docs.flywheel.paradigma.inc/cli/files-list {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel files:list`. ## Command Group [#command-group] Artifacts & Files Commands ## Summary [#summary] List all your files across nodes. ## Usage [#usage] ```bash flywheel files:list [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--page` | `integer` | | | Page number. | | `--page_size` | `integer` | | | Page size (canonical). | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] List files. ``` flywheel files:list --page 1 --page_size 50 ``` --- # github:disconnect Canonical URL: https://docs.flywheel.paradigma.inc/cli/github-disconnect {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel github:disconnect`. ## Command Group [#command-group] Integrations Commands ## Summary [#summary] Disconnect GitHub from your account. ## Usage [#usage] ```bash flywheel github:disconnect [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Disconnect. ``` flywheel github:disconnect ``` --- # github:link Canonical URL: https://docs.flywheel.paradigma.inc/cli/github-link {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel github:link`. ## Command Group [#command-group] Integrations Commands ## Summary [#summary] Start the GitHub App install/link browser flow. ## Usage [#usage] ```bash flywheel github:link [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Open the GitHub App install flow. ``` flywheel github:link --open ``` --- # github:refresh-repos Canonical URL: https://docs.flywheel.paradigma.inc/cli/github-refresh-repos {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel github:refresh-repos`. ## Command Group [#command-group] Integrations Commands ## Summary [#summary] Refresh the list of accessible repositories. ## Usage [#usage] ```bash flywheel github:refresh-repos [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Refresh. ``` flywheel github:refresh-repos ``` --- # github:status Canonical URL: https://docs.flywheel.paradigma.inc/cli/github-status {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel github:status`. ## Command Group [#command-group] Integrations Commands ## Summary [#summary] Check GitHub connection status. ## Usage [#usage] ```bash flywheel github:status [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Status. ``` flywheel github:status ``` --- # graph:get Canonical URL: https://docs.flywheel.paradigma.inc/cli/graph-get {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel graph:get`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Read the graph projection for navigation and topology workflows. ## Usage [#usage] ```bash flywheel graph:get [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | `--node_id` | `string` | | | Scope to a root node. | | `--depth` | `integer` | | | Max depth. | | `--max_nodes` | `integer` | | | Max nodes in response. | | `--page_size` | `integer` | | | Graph page size. | | `--cursor` | `string` | | | Cursor returned by the previous graph page. | | `--filter` | `string` | | | Comma-separated node filter tokens, e.g. include:tag:tag-priority. Axes: owner, root\_graph, tag, visibility, recency. | | `--exclude` | `string` | | | Comma-separated exclude shorthand tokens, e.g. owner:\. Axes: owner, root\_graph, tag, visibility, recency. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Read the graph scoped to a root. ``` flywheel graph:get --node_id r_root --depth 3 ``` Read the first graph page. ``` flywheel graph:get --page_size 10000 ``` Read the next graph page. ``` flywheel graph:get --page_size 10000 --cursor ``` Read a filtered graph page. ``` flywheel graph:get --filter include:tag:tag-priority --exclude owner: ``` --- # help Canonical URL: https://docs.flywheel.paradigma.inc/cli/help {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel help`. ## Command Group [#command-group] Setup Commands ## Summary [#summary] Show Flywheel CLI help. ## Usage [#usage] ```bash flywheel help [FLAGS] [command] ``` ## Arguments [#arguments] | Argument | Required | Choices | Description | | ----------- | -------- | ------- | ------------------------ | | `[command]` | No | | Command name to inspect. | ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | --------------- | -------- | ------- | ------- | ----------------------------------------------------------- | | `-a, --aliases` | | | | List public command shortcuts. | | `--format` | `FORMAT` | | `json` | Output help metadata as JSON. | | `--schema` | | | | Print a minimal JSON payload schema for supported commands. | ## Examples [#examples] No examples are declared in the Usage source. --- # hooks:create Canonical URL: https://docs.flywheel.paradigma.inc/cli/hooks-create {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel hooks:create`. ## Command Group [#command-group] Hooks Commands ## Summary [#summary] Create a new hook on an owner node. ## Usage [#usage] ```bash flywheel hooks:create ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------- | -------- | ------- | ------- | ----------------------------------------- | | `--owner_node_id` | `string` | | | Owner node identifier. | | `--name` | `string` | | | Human-readable hook name. | | `--workflow_yaml` | `string` | | | Workflow YAML payload for hook execution. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--scope` | `string` | | | Hook scope: self\|subtree\|graph. | | `--rerun_policy` | `string` | | | Rerun policy (currently only if\_inputs\_changed). | | `--enabled` | | | | Set initial enabled state. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Create an enabled subtree hook. ``` flywheel hooks:create --owner_node_id n_owner --name build --workflow_yaml "on:\n artifact.finalized: {}\njobs:\n main:\n steps:\n - id: call_eval\n uses: flywheel/http_request@v1\n with:\n url: https://example.invalid/eval\n method: POST" --scope subtree --enabled ``` Create an enabled subtree hook that tags finalized submissions. ``` flywheel hooks:create --owner_node_id n_owner --name tag-red-submissions --workflow_yaml 'on:\n artifact.finalized: {}\nif:\n any_artifact:\n field: metadata.submission_kind\n eq: red\njobs:\n main:\n steps:\n - id: tag_red_submission\n uses: flywheel/add_node_tags@v1\n with:\n node_id: ${{ event.source_node_id }}\n tag_ids:\n - tag-red-submission' --scope subtree --enabled ``` --- # hooks:delete Canonical URL: https://docs.flywheel.paradigma.inc/cli/hooks-delete {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel hooks:delete`. ## Command Group [#command-group] Hooks Commands ## Summary [#summary] Delete a hook from an owner node. ## Usage [#usage] ```bash flywheel hooks:delete ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------- | -------- | ------- | ------- | ---------------------- | | `--owner_node_id` | `string` | | | Owner node identifier. | | `--hook_id` | `string` | | | Hook identifier. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Delete one hook. ``` flywheel hooks:delete --owner_node_id n_owner --hook_id hk_1 ``` --- # hooks:list Canonical URL: https://docs.flywheel.paradigma.inc/cli/hooks-list {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel hooks:list`. ## Command Group [#command-group] Hooks Commands ## Summary [#summary] List hooks configured for an owner node. ## Usage [#usage] ```bash flywheel hooks:list ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------- | -------- | ------- | ------- | ---------------------- | | `--owner_node_id` | `string` | | | Owner node identifier. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | -------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--include_disabled` | | | | Include disabled hooks in the response. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] List all hooks including disabled entries. ``` flywheel hooks:list --owner_node_id n_owner --include_disabled ``` --- # hooks:runs:list Canonical URL: https://docs.flywheel.paradigma.inc/cli/hooks-runs-list {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel hooks:runs:list`. ## Command Group [#command-group] Hooks Commands ## Summary [#summary] List hook runs for an owner node. ## Usage [#usage] ```bash flywheel hooks:runs:list ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------- | -------- | ------- | ------- | ---------------------- | | `--owner_node_id` | `string` | | | Owner node identifier. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--hook_id` | `string` | | | Filter runs to one hook ID. | | `--limit` | `integer` | | | Maximum number of runs to return. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] List the last 25 runs for one hook. ``` flywheel hooks:runs:list --owner_node_id n_owner --hook_id hk_1 --limit 25 ``` --- # hooks:secrets:create Canonical URL: https://docs.flywheel.paradigma.inc/cli/hooks-secrets-create {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel hooks:secrets:create`. ## Command Group [#command-group] Hooks Commands ## Summary [#summary] Create a hook secret. ## Usage [#usage] ```bash flywheel hooks:secrets:create ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------- | -------- | ------- | ------- | ----------------------- | | `--owner_node_id` | `string` | | | Owner node identifier. | | `--name` | `string` | | | Secret name. | | `--value` | `string` | | | Secret plaintext value. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Create one hook secret. ``` flywheel hooks:secrets:create --owner_node_id n_owner --name API_TOKEN --value token ``` --- # hooks:secrets:delete Canonical URL: https://docs.flywheel.paradigma.inc/cli/hooks-secrets-delete {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel hooks:secrets:delete`. ## Command Group [#command-group] Hooks Commands ## Summary [#summary] Delete one hook secret. ## Usage [#usage] ```bash flywheel hooks:secrets:delete ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------- | -------- | ------- | ------- | ---------------------- | | `--owner_node_id` | `string` | | | Owner node identifier. | | `--secret_id` | `string` | | | Secret identifier. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Delete one hook secret. ``` flywheel hooks:secrets:delete --owner_node_id n_owner --secret_id hs_1 ``` --- # hooks:secrets:list Canonical URL: https://docs.flywheel.paradigma.inc/cli/hooks-secrets-list {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel hooks:secrets:list`. ## Command Group [#command-group] Hooks Commands ## Summary [#summary] List hook secret metadata for an owner node. ## Usage [#usage] ```bash flywheel hooks:secrets:list ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------- | -------- | ------- | ------- | ---------------------- | | `--owner_node_id` | `string` | | | Owner node identifier. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] List secrets configured for hooks on an owner node. ``` flywheel hooks:secrets:list --owner_node_id n_owner ``` --- # hooks:secrets:update Canonical URL: https://docs.flywheel.paradigma.inc/cli/hooks-secrets-update {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel hooks:secrets:update`. ## Command Group [#command-group] Hooks Commands ## Summary [#summary] Rotate one hook secret value. ## Usage [#usage] ```bash flywheel hooks:secrets:update ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------- | -------- | ------- | ------- | --------------------------- | | `--owner_node_id` | `string` | | | Owner node identifier. | | `--secret_id` | `string` | | | Secret identifier. | | `--value` | `string` | | | New secret plaintext value. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Rotate one hook secret. ``` flywheel hooks:secrets:update --owner_node_id n_owner --secret_id hs_1 --value rotated ``` --- # hooks:set-enabled Canonical URL: https://docs.flywheel.paradigma.inc/cli/hooks-set-enabled {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel hooks:set-enabled`. ## Command Group [#command-group] Hooks Commands ## Summary [#summary] Enable or disable an existing hook. ## Usage [#usage] ```bash flywheel hooks:set-enabled ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------- | -------- | ------- | ------- | ---------------------- | | `--owner_node_id` | `string` | | | Owner node identifier. | | `--hook_id` | `string` | | | Hook identifier. | | `--enabled` | | | | Desired enabled state. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Disable one hook. ``` flywheel hooks:set-enabled --owner_node_id n_owner --hook_id hk_1 --enabled=false ``` --- # hooks:update Canonical URL: https://docs.flywheel.paradigma.inc/cli/hooks-update {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel hooks:update`. ## Command Group [#command-group] Hooks Commands ## Summary [#summary] Update mutable hook fields for an existing hook. ## Usage [#usage] ```bash flywheel hooks:update ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------- | -------- | ------- | ------- | ---------------------- | | `--owner_node_id` | `string` | | | Owner node identifier. | | `--hook_id` | `string` | | | Hook identifier. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--name` | `string` | | | Updated hook name. | | `--scope` | `string` | | | Updated scope: self\|subtree\|graph. | | `--workflow_yaml` | `string` | | | Updated workflow YAML payload. | | `--rerun_policy` | `string` | | | Updated rerun policy (if\_inputs\_changed). | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Move a hook to graph scope. ``` flywheel hooks:update --owner_node_id n_owner --hook_id hk_1 --scope graph ``` --- # import:subgraph Canonical URL: https://docs.flywheel.paradigma.inc/cli/import-subgraph {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel import:subgraph`. ## Command Group [#command-group] Export & Import Commands ## Summary [#summary] Import graph JSON into new node records. ## Usage [#usage] ```bash flywheel import:subgraph ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | ------ | ------- | ------- | -------------------------------------------------- | | `--payload` | `json` | | | Inline JSON or @file path with the import payload. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Import from a file. ``` flywheel import:subgraph --payload=@subgraph.json ``` --- # CLI Reference Canonical URL: https://docs.flywheel.paradigma.inc/cli {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Inspect, organize, and operate Flywheel research graphs from the command line. ## Command catalog [#command-catalog] This reference is generated from `flywheel --usage-spec` and contains 138 command pages. ## Setup Commands [#setup-commands] | Command | Summary | | -------------------------------------------------------------- | ---------------------------------------------------------------------- | | [`flywheel completion`](/cli/completion) | Generate a shell completion script from the public Flywheel Usage spec | | [`flywheel completion bash`](/cli/completion-bash) | Generate a bash shell completion script | | [`flywheel completion fish`](/cli/completion-fish) | Generate a fish shell completion script | | [`flywheel completion install`](/cli/completion-install) | Install a generated shell completion script to a user-level location | | [`flywheel completion nu`](/cli/completion-nu) | Generate a nu shell completion script | | [`flywheel completion nushell`](/cli/completion-nushell) | Generate a nushell shell completion script | | [`flywheel completion powershell`](/cli/completion-powershell) | Generate a powershell shell completion script | | [`flywheel completion uninstall`](/cli/completion-uninstall) | Remove Flywheel-managed shell completion files and profile blocks | | [`flywheel completion zsh`](/cli/completion-zsh) | Generate a zsh shell completion script | | [`flywheel help`](/cli/help) | Show Flywheel CLI help. | | [`flywheel setup`](/cli/setup) | Set up Flywheel for your AI coding host | | [`flywheel uninstall`](/cli/uninstall) | Remove Flywheel MCP entries and bundled skills from selected hosts | | [`flywheel version`](/cli/version) | Print the Flywheel CLI version. | ## Auth Commands [#auth-commands] | Command | Summary | | ---------------------------------------------------------- | ---------------------------------------------------------------------------- | | [`flywheel auth:keychain:clear`](/cli/auth-keychain-clear) | Remove an API key from the OS keychain for a profile. | | [`flywheel auth:keychain:set`](/cli/auth-keychain-set) | Store an API key in the OS keychain for a profile. Reads the key from stdin. | | [`flywheel auth:login`](/cli/auth-login) | Bootstrap API key auth through RFC 8628 device authorization flow. | | [`flywheel auth:status`](/cli/auth-status) | Show authentication status for the current client context. | ## Profile Commands [#profile-commands] | Command | Summary | | ---------------------------------------------- | ------------------------------------------------------------------------- | | [`flywheel profile:list`](/cli/profile-list) | List configured CLI profiles (local only). | | [`flywheel profile:set`](/cli/profile-set) | Create or update a CLI profile (local only; never stores plaintext keys). | | [`flywheel profile:show`](/cli/profile-show) | Show a profile definition (local only). | | [`flywheel profile:unset`](/cli/profile-unset) | Delete a CLI profile (local only). | ## Nodes & Graph Commands [#nodes--graph-commands] | Command | Summary | | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | | [`flywheel campaign:snapshot`](/cli/campaign-snapshot) | Resolve campaign root snapshot for a node. | | [`flywheel graph:get`](/cli/graph-get) | Read the graph projection for navigation and topology workflows. | | [`flywheel nodes:add-parent`](/cli/nodes-add-parent) | Add a parent-child edge (mirrors POST /nodes/\{node\_id}/parents/add). | | [`flywheel nodes:branch`](/cli/nodes-branch) | Create a child branch from a node. | | [`flywheel nodes:children`](/cli/nodes-children) | Page direct visible children for one node. | | [`flywheel nodes:commit`](/cli/nodes-commit) | Commit staged changes to an existing node. | | [`flywheel nodes:commit-new`](/cli/nodes-commit-new) | Create and commit a new node in one request. | | [`flywheel nodes:create`](/cli/nodes-create) | Create a minimal node (title only) and emit graph-change event. | | [`flywheel nodes:delete`](/cli/nodes-delete) | Delete a node by identifier. Requires --yes. | | [`flywheel nodes:delete-bulk`](/cli/nodes-delete-bulk) | Delete multiple node subtrees. Requires --yes. | | [`flywheel nodes:files`](/cli/nodes-files) | List files attached to a node. | | [`flywheel nodes:get`](/cli/nodes-get) | Fetch one node by identifier. Use relationship paging commands for complete direct-neighbor traversal. | | [`flywheel nodes:list`](/cli/nodes-list) | List nodes with optional filters. | | [`flywheel nodes:merge`](/cli/nodes-merge) | Merge multiple nodes into one resolved node. | | [`flywheel nodes:parents`](/cli/nodes-parents) | Page direct visible parents for one node. | | [`flywheel nodes:remove-parent`](/cli/nodes-remove-parent) | Remove a parent-child edge. | | [`flywheel nodes:render:ancestry`](/cli/nodes-render-ancestry) | Render ancestry (roots-ward lineage) for a node. | | [`flywheel nodes:render:summary`](/cli/nodes-render-summary) | Render a compact summary of a node subtree. | | [`flywheel nodes:render:tree`](/cli/nodes-render-tree) | Render a bounded tree projection for a node. | | [`flywheel nodes:resolve-slug`](/cli/nodes-resolve-slug) | Resolve a slug to a node ID. | | [`flywheel nodes:sharing:get`](/cli/nodes-sharing-get) | Get sharing (access policy) for a node. | | [`flywheel nodes:sharing:set`](/cli/nodes-sharing-set) | Replace sharing (access policy) for a node. | | [`flywheel nodes:sharing:set-bulk`](/cli/nodes-sharing-set-bulk) | Apply one sharing policy to multiple nodes. | | [`flywheel nodes:sharing:summaries`](/cli/nodes-sharing-summaries) | Read access summaries for multiple nodes in one batch. | | [`flywheel nodes:stage:lease:acquire`](/cli/nodes-stage-lease-acquire) | Acquire an edit lease for an existing node. | | [`flywheel nodes:stage:lease:heartbeat`](/cli/nodes-stage-lease-heartbeat) | Heartbeat an active node stage lease. | | [`flywheel nodes:stage:lease:release`](/cli/nodes-stage-lease-release) | Release a node stage lease. | | [`flywheel remote-artifacts:refresh`](/cli/remote-artifacts-refresh) | Force refresh a public HTTPS JSON Remote Artifact for a node. | | [`flywheel remote-artifacts:resolve`](/cli/remote-artifacts-resolve) | Resolve a public HTTPS JSON Remote Artifact for a node. | | [`flywheel tags:assign`](/cli/tags-assign) | Assign or clear tags on a node (atomic replace). | | [`flywheel tags:create`](/cli/tags-create) | Create a reusable tag on a graph root. | | [`flywheel tags:delete`](/cli/tags-delete) | Delete a tag definition from the graph. | | [`flywheel tags:update`](/cli/tags-update) | Update a tag definition. | ## Artifacts & Files Commands [#artifacts--files-commands] | Command | Summary | | ---------------------------------------------------------------------- | ------------------------------------------------------------------- | | [`flywheel artifacts:delete`](/cli/artifacts-delete) | Delete an artifact from a node. | | [`flywheel artifacts:delete-bulk`](/cli/artifacts-delete-bulk) | Delete multiple artifacts from one node. | | [`flywheel artifacts:get`](/cli/artifacts-get) | Fetch one artifact metadata record. | | [`flywheel artifacts:list`](/cli/artifacts-list) | List artifacts for a node. | | [`flywheel artifacts:note:set`](/cli/artifacts-note-set) | Add, update, or clear an artifact note. | | [`flywheel artifacts:upload`](/cli/artifacts-upload) | One-shot upload: prepare + PUT + finalize from a single invocation. | | [`flywheel artifacts:upload:finalize`](/cli/artifacts-upload-finalize) | Finalize prepared artifact uploads and attach artifacts. | | [`flywheel artifacts:upload:prepare`](/cli/artifacts-upload-prepare) | Create upload batch with signed per-item upload tickets. | | [`flywheel files:list`](/cli/files-list) | List all your files across nodes. | ## Hooks Commands [#hooks-commands] | Command | Summary | | ------------------------------------------------------------ | ------------------------------------------------ | | [`flywheel hooks:create`](/cli/hooks-create) | Create a new hook on an owner node. | | [`flywheel hooks:delete`](/cli/hooks-delete) | Delete a hook from an owner node. | | [`flywheel hooks:list`](/cli/hooks-list) | List hooks configured for an owner node. | | [`flywheel hooks:runs:list`](/cli/hooks-runs-list) | List hook runs for an owner node. | | [`flywheel hooks:secrets:create`](/cli/hooks-secrets-create) | Create a hook secret. | | [`flywheel hooks:secrets:delete`](/cli/hooks-secrets-delete) | Delete one hook secret. | | [`flywheel hooks:secrets:list`](/cli/hooks-secrets-list) | List hook secret metadata for an owner node. | | [`flywheel hooks:secrets:update`](/cli/hooks-secrets-update) | Rotate one hook secret value. | | [`flywheel hooks:set-enabled`](/cli/hooks-set-enabled) | Enable or disable an existing hook. | | [`flywheel hooks:update`](/cli/hooks-update) | Update mutable hook fields for an existing hook. | ## Compute & Executions Commands [#compute--executions-commands] | Command | Summary | | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------- | | [`flywheel compute:acquire`](/cli/compute-acquire) | Acquire managed compute for a node; with --wait, wait for usable SSH connection material. | | [`flywheel compute:budgets`](/cli/compute-budgets) | List budget grants visible for a node context. | | [`flywheel compute:connection`](/cli/compute-connection) | Get SSH connection material for a usable lease. | | [`flywheel compute:funding`](/cli/compute-funding) | Read grant-scoped funding context before compute acquire. | | [`flywheel compute:options`](/cli/compute-options) | List allowed compute catalog options for a node. | | [`flywheel compute:release`](/cli/compute-release) | Release one active compute lease (async; use --wait to block). | | [`flywheel compute:release-all`](/cli/compute-release-all) | Release all active leases in current scope (pass --force for account scope). | | [`flywheel compute:status`](/cli/compute-status) | Return compute lease status. | | [`flywheel executions:launch`](/cli/executions-launch) | Start an execution for a node. | | [`flywheel executions:list`](/cli/executions-list) | List executions for a node. | | [`flywheel executions:terminate`](/cli/executions-terminate) | Stop an execution for a node. | ## Approvals & Budgets Commands [#approvals--budgets-commands] | Command | Summary | | -------------------------------------------------------------------------- | --------------------------------------------- | | [`flywheel approval-sessions:expire`](/cli/approval-sessions-expire) | Expire an approval session. | | [`flywheel approval-sessions:heartbeat`](/cli/approval-sessions-heartbeat) | Create or refresh a compute approval session. | | [`flywheel approval-sessions:list`](/cli/approval-sessions-list) | List approval sessions. | | [`flywheel campaign-budgets:create`](/cli/campaign-budgets-create) | Create a campaign compute budget grant. | | [`flywheel campaign-budgets:list`](/cli/campaign-budgets-list) | List campaign compute budgets for a root. | | [`flywheel campaign-budgets:revoke`](/cli/campaign-budgets-revoke) | Revoke a campaign budget grant. | | [`flywheel campaign-budgets:update`](/cli/campaign-budgets-update) | Update a campaign budget. | ## Export & Import Commands [#export--import-commands] | Command | Summary | | ---------------------------------------------------------------------- | ------------------------------------------------------- | | [`flywheel export:history`](/cli/export-history) | Export node history as JSONL. | | [`flywheel export:subgraph`](/cli/export-subgraph) | Export a subgraph snapshot. | | [`flywheel export:summary`](/cli/export-summary) | Generate a markdown summary export. | | [`flywheel export:summary:pdf`](/cli/export-summary-pdf) | Render summary as PDF; requires --out. | | [`flywheel export:summary:render-pdf`](/cli/export-summary-render-pdf) | Render caller-provided markdown as PDF; requires --out. | | [`flywheel export:summary:stream`](/cli/export-summary-stream) | Stream summary generation as NDJSON events. | | [`flywheel import:subgraph`](/cli/import-subgraph) | Import graph JSON into new node records. | ## Updates & Resources Commands [#updates--resources-commands] | Command | Summary | | ------------------------------------------------------------------ | --------------------------------------------------- | | [`flywheel blobs:get`](/cli/blobs-get) | Download a raw blob by storage key. | | [`flywheel machines:list`](/cli/machines-list) | List your managed compute leases. | | [`flywheel updates:hide`](/cli/updates-hide) | Hide a specific announcement. | | [`flywheel updates:hide-all-active`](/cli/updates-hide-all-active) | Hide all currently active announcements. | | [`flywheel updates:list`](/cli/updates-list) | List in-app announcements relevant to your account. | | [`flywheel updates:unhide`](/cli/updates-unhide) | Restore a previously hidden announcement. | ## Account & Credits Commands [#account--credits-commands] | Command | Summary | | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`flywheel account:detach`](/cli/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`](/cli/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`](/cli/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`](/cli/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`](/cli/account-get) | View account snapshot and linked identities. | | [`flywheel account:merge`](/cli/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`](/cli/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`](/cli/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`](/cli/credits-balance) | View credit balance and totals. | | [`flywheel credits:billing-portal`](/cli/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`](/cli/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`](/cli/credits-referral) | View your referral code and status. | | [`flywheel credits:referral:claim`](/cli/credits-referral-claim) | Claim referral rewards using a code. | | [`flywheel credits:subscribe`](/cli/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`](/cli/credits-subscription) | View your subscription status. | | [`flywheel credits:transactions`](/cli/credits-transactions) | View paginated credit transactions. | | [`flywheel credits:usage`](/cli/credits-usage) | Feature-based usage breakdown over a window. | ## Integrations Commands [#integrations-commands] | Command | Summary | | ---------------------------------------------------------------------------------- | --------------------------------------------------------- | | [`flywheel github:disconnect`](/cli/github-disconnect) | Disconnect GitHub from your account. | | [`flywheel github:link`](/cli/github-link) | Start the GitHub App install/link browser flow. | | [`flywheel github:refresh-repos`](/cli/github-refresh-repos) | Refresh the list of accessible repositories. | | [`flywheel github:status`](/cli/github-status) | Check GitHub connection status. | | [`flywheel integrations:huggingface:remove`](/cli/integrations-huggingface-remove) | Remove your Hugging Face credential. | | [`flywheel integrations:huggingface:set`](/cli/integrations-huggingface-set) | Store a Hugging Face access token. | | [`flywheel integrations:status`](/cli/integrations-status) | Check integration connection status (W\&B, Hugging Face). | | [`flywheel integrations:wandb:remove`](/cli/integrations-wandb-remove) | Remove your W\&B credential. | | [`flywheel integrations:wandb:set`](/cli/integrations-wandb-set) | Store a Weights & Biases API key. | ## API Keys Commands [#api-keys-commands] | Command | Summary | | -------------------------------------------------- | ------------------------------------------------------------------------- | | [`flywheel api-keys:create`](/cli/api-keys-create) | Create a new API key and return the raw material once. | | [`flywheel api-keys:delete`](/cli/api-keys-delete) | Delete an API key (refuses to delete the active one unless --allow-self). | | [`flywheel api-keys:list`](/cli/api-keys-list) | List your API keys. | | [`flywheel api-keys:rotate`](/cli/api-keys-rotate) | Rotate an API key (refuses to rotate the active one unless --allow-self). | ## Other Commands [#other-commands] | Command | Summary | | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | [`flywheel compute-grants:list`](/cli/compute-grants-list) | List compute grants available to the user. | | [`flywheel compute-grants:request-approval`](/cli/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`](/cli/feedback-create) | Submit bounded feedback to the Flywheel team. | | [`flywheel update`](/cli/update) | Update the local Flywheel CLI package and setup artifacts | --- # integrations:huggingface:remove Canonical URL: https://docs.flywheel.paradigma.inc/cli/integrations-huggingface-remove {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel integrations:huggingface:remove`. ## Command Group [#command-group] Integrations Commands ## Summary [#summary] Remove your Hugging Face credential. ## Usage [#usage] ```bash flywheel integrations:huggingface:remove [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Remove. ``` flywheel integrations:huggingface:remove ``` --- # integrations:huggingface:set Canonical URL: https://docs.flywheel.paradigma.inc/cli/integrations-huggingface-set {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel integrations:huggingface:set`. ## Command Group [#command-group] Integrations Commands ## Summary [#summary] Store a Hugging Face access token. ## Usage [#usage] ```bash flywheel integrations:huggingface:set [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--token` | `string` | | | HF access token. | | `--token_env` | `string` | | | Environment variable containing the HF access token. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Store HF token from an environment variable. ``` flywheel integrations:huggingface:set --token_env HF_TOKEN ``` --- # integrations:status Canonical URL: https://docs.flywheel.paradigma.inc/cli/integrations-status {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel integrations:status`. ## Command Group [#command-group] Integrations Commands ## Summary [#summary] Check integration connection status (W\&B, Hugging Face). ## Usage [#usage] ```bash flywheel integrations:status [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Status. ``` flywheel integrations:status ``` --- # integrations:wandb:remove Canonical URL: https://docs.flywheel.paradigma.inc/cli/integrations-wandb-remove {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel integrations:wandb:remove`. ## Command Group [#command-group] Integrations Commands ## Summary [#summary] Remove your W\&B credential. ## Usage [#usage] ```bash flywheel integrations:wandb:remove [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Remove. ``` flywheel integrations:wandb:remove ``` --- # integrations:wandb:set Canonical URL: https://docs.flywheel.paradigma.inc/cli/integrations-wandb-set {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel integrations:wandb:set`. ## Command Group [#command-group] Integrations Commands ## Summary [#summary] Store a Weights & Biases API key. ## Usage [#usage] ```bash flywheel integrations:wandb:set [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--api_key` | `string` | | | W\&B API key. | | `--api_key_env` | `string` | | | Environment variable containing the W\&B API key. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Store W\&B key from an environment variable. ``` flywheel integrations:wandb:set --api_key_env WANDB_API_KEY ``` --- # machines:list Canonical URL: https://docs.flywheel.paradigma.inc/cli/machines-list {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel machines:list`. ## Command Group [#command-group] Updates & Resources Commands ## Summary [#summary] List your managed compute leases. ## Usage [#usage] ```bash flywheel machines:list [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] List machines. ``` flywheel machines:list ``` --- # nodes:add-parent Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-add-parent {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:add-parent`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Add a parent-child edge (mirrors POST /nodes/\{node\_id}/parents/add). ## Usage [#usage] ```bash flywheel nodes:add-parent ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ---------------------------- | --------- | ------- | ------- | ------------------------------------ | | `--node_id` | `string` | | | Child node receiving the edge. | | `--parent_id` | `string` | | | Parent node to attach. | | `--expected_revision` | `integer` | | | Optimistic lock for the child node. | | `--expected_parent_revision` | `integer` | | | Optimistic lock for the parent node. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Attach a parent. ``` flywheel nodes:add-parent --node_id n_child --parent_id n_parent --expected_revision 5 --expected_parent_revision 2 ``` --- # nodes:branch Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-branch {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:branch`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Create a child branch from a node. ## Usage [#usage] ```bash flywheel nodes:branch ``` ## Aliases [#aliases] `nb` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | -------- | ------- | ------- | ------------ | | `--node_id` | `string` | | | Source node. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | --------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--expected_revision` | `integer` | | | Optimistic lock. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Read the current revision, then branch from a node. ``` flywheel nodes:get --node_id n_abc --format=json flywheel nodes:branch --node_id n_abc --expected_revision 7 ``` --- # nodes:children Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-children {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:children`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Page direct visible children for one node. ## Usage [#usage] ```bash flywheel nodes:children ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | -------- | ------- | ------- | ----------------------- | | `--node_id` | `string` | | | Target node identifier. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ---------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--first` | `integer` | `100` | | Maximum edges to return (server clamps to 1..500). | | `--after` | `string` | | | Opaque end\_cursor from a previous page. | | `--projection` | `string` | `topology` | | Node payload projection for each edge (topology or core). | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Read the first page of children. ``` flywheel nodes:children --node_id n_abc --first 100 ``` Continue from a previous page cursor. ``` flywheel nodes:children --node_id n_abc --after cursor_abc --projection core ``` --- # nodes:commit-new Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-commit-new {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:commit-new`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Create and commit a new node in one request. ## Usage [#usage] ```bash flywheel nodes:commit-new ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ---------------- | ------ | ------- | ------- | ----------------------------------------------------------------------------------- | | `--payload_json` | `json` | | | Inline JSON or @file path for the full commit-new payload (see --schema for shape). | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Commit a new node from a payload file. ``` flywheel nodes:commit-new --payload_json=@commit-new.json ``` See the minimal JSON payload shape. ``` flywheel help nodes:commit-new --schema ``` --- # nodes:commit Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-commit {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:commit`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Commit staged changes to an existing node. ## Usage [#usage] ```bash flywheel nodes:commit ``` ## Aliases [#aliases] `nc` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ---------------- | -------- | ------- | ------- | -------------------------------------------------------------------------- | | `--node_id` | `string` | | | Target node identifier. | | `--payload_json` | `json` | | | Inline JSON or @file path for the commit payload (see --schema for shape). | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Commit a staged payload from a file. ``` flywheel nodes:commit --node_id n_abc --payload_json=@commit.json ``` See the minimal JSON payload shape. ``` flywheel help nodes:commit --schema ``` --- # nodes:create Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-create {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:create`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Create a minimal node (title only) and emit graph-change event. ## Usage [#usage] ```bash flywheel nodes:create ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------- | -------- | ------- | ------- | ----------- | | `--title` | `string` | | | Node title. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Create a node. ``` flywheel nodes:create --title "my new node" ``` --- # nodes:delete-bulk Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-delete-bulk {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:delete-bulk`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Delete multiple node subtrees. Requires --yes. ## Usage [#usage] ```bash flywheel nodes:delete-bulk ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ------------ | -------- | ------- | ------- | ------------------------- | | `--node_ids` | `string` | | | Comma-separated node IDs. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--delete_mode` | `string` | | | cascade \| detach\_shared (default detach\_shared). | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Bulk delete. ``` flywheel nodes:delete-bulk --node_ids n1,n2 --delete_mode cascade --yes ``` --- # nodes:delete Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-delete {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:delete`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Delete a node by identifier. Requires --yes. ## Usage [#usage] ```bash flywheel nodes:delete ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | -------- | ------- | ------- | ----------------------- | | `--node_id` | `string` | | | Target node identifier. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--delete_mode` | `string` | | | cascade \| detach\_shared (default detach\_shared). | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Delete a node. ``` flywheel nodes:delete --node_id n_abc --yes ``` Delete a node using the --key=value form with JSON output. ``` flywheel nodes:delete --node_id=n_abc --delete_mode=cascade --format=json --yes ``` --- # nodes:files Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-files {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:files`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] List files attached to a node. ## Usage [#usage] ```bash flywheel nodes:files ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | -------- | ------- | ------- | ------------ | | `--node_id` | `string` | | | Owning node. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] List files. ``` flywheel nodes:files --node_id n_abc ``` --- # nodes:get Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-get {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:get`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Fetch one node by identifier. Use relationship paging commands for complete direct-neighbor traversal. ## Usage [#usage] ```bash flywheel nodes:get ``` ## Aliases [#aliases] `ng` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | -------- | ------- | ------- | ----------------------- | | `--node_id` | `string` | | | Target node identifier. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `--projection` | `string` | | | Response projection (core, topology, or full); topology is lightweight metadata and does not guarantee complete relationship arrays. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Fetch a node with the core projection. ``` flywheel nodes:get --node_id n_abc --projection core ``` Fetch the topology projection as TSV for scripting. ``` flywheel nodes:get --node_id n_abc --projection topology --format=tsv ``` --- # nodes:list Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-list {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:list`. Use this command when you need a lightweight read of graph nodes before drilling into a specific node or branch. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] List nodes with optional filters. ## Usage [#usage] ```bash flywheel nodes:list [FLAGS] ``` ## Aliases [#aliases] `nl` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | Notes | | -------------------- | --------- | ---------------- | ----------------------------- | -------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | | `--page` | `integer` | `1` | | Page number (1-based). | | | `--page_size` | `integer` | `server default` | | Page size. | | | `--status` | `string` | | | Filter by node status. | | | `--include_archived` | | | | Include archived nodes. | | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | Use `json` for scripts and `table` for quick terminal inspection. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | | `--open` | | | | Open browser-bound URLs when supported. | | | `--no-retry` | | | | Disable transient-error retries. | | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | | `--wait` | | | | Block on async operations until a terminal state is reached. | | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | | `--allow-self` | | | | Allow mutating the currently active credential. | | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | | `--force` | | | | Force safety-gated operations where supported. | | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | | `--debug` | | | | Print structured request debugging with secrets masked. | | | `--verbose` | | | | Print verbose progress for long-running operations. | | | `-h, --help` | | | | Show this help. | | ## Examples [#examples] List the first page of active nodes. ``` flywheel nodes:list --page 1 --page_size 20 ``` Include archived nodes in the output. ``` flywheel nodes:list --include_archived ``` --- # nodes:merge Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-merge {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:merge`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Merge multiple nodes into one resolved node. ## Usage [#usage] ```bash flywheel nodes:merge ``` ## Aliases [#aliases] `nm` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------------------------- | -------- | ------- | ------- | ----------------------------------------- | | `--node_ids` | `string` | | | Comma-separated node IDs. | | `--expected_revision_by_node` | `json` | | | JSON object mapping node\_id to revision. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--title` | `string` | | | Resolved node title. | | `--resolved_node` | `json` | | | Resolved node JSON blob. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Read current revisions, then merge two branches. ``` flywheel nodes:get --node_id n1 --format=json flywheel nodes:get --node_id n2 --format=json flywheel nodes:merge --node_ids n1,n2 --expected_revision_by_node '{"n1":5,"n2":3}' ``` --- # nodes:parents Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-parents {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:parents`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Page direct visible parents for one node. ## Usage [#usage] ```bash flywheel nodes:parents ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | -------- | ------- | ------- | ----------------------- | | `--node_id` | `string` | | | Target node identifier. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ---------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--first` | `integer` | `100` | | Maximum edges to return (server clamps to 1..500). | | `--after` | `string` | | | Opaque end\_cursor from a previous page. | | `--projection` | `string` | `topology` | | Node payload projection for each edge (topology or core). | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Read the first page of parents. ``` flywheel nodes:parents --node_id n_abc --first 100 ``` Continue from a previous page cursor. ``` flywheel nodes:parents --node_id n_abc --after cursor_abc --projection core ``` --- # nodes:remove-parent Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-remove-parent {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:remove-parent`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Remove a parent-child edge. ## Usage [#usage] ```bash flywheel nodes:remove-parent ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ---------------------------- | --------- | ------- | ------- | ------------------------------------ | | `--node_id` | `string` | | | Child node identifier. | | `--parent_id` | `string` | | | Parent node identifier. | | `--expected_revision` | `integer` | | | Optimistic lock for the child node. | | `--expected_parent_revision` | `integer` | | | Optimistic lock for the parent node. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Detach a parent. ``` flywheel nodes:remove-parent --node_id n_child --parent_id n_parent --expected_revision 5 --expected_parent_revision 2 ``` --- # nodes:render:ancestry Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-render-ancestry {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:render:ancestry`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Render ancestry (roots-ward lineage) for a node. ## Usage [#usage] ```bash flywheel nodes:render:ancestry ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | -------- | ------- | ------- | ----------- | | `--node_id` | `string` | | | Node ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--max_depth` | `integer` | | | Max depth. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Render ancestry. ``` flywheel nodes:render:ancestry --node_id n_abc --max_depth 5 ``` --- # nodes:render:summary Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-render-summary {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:render:summary`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Render a compact summary of a node subtree. ## Usage [#usage] ```bash flywheel nodes:render:summary ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | -------- | ------- | ------- | ----------- | | `--node_id` | `string` | | | Node ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--max_nodes` | `integer` | | | Max nodes in summary. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Render summary. ``` flywheel nodes:render:summary --node_id n_abc ``` --- # nodes:render:tree Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-render-tree {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:render:tree`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Render a bounded tree projection for a node. ## Usage [#usage] ```bash flywheel nodes:render:tree ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | -------- | ------- | ------- | --------------------- | | `--node_id` | `string` | | | Root node identifier. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--projection` | `string` | | | Response projection (e.g. topology, core). | | `--max_depth` | `integer` | | | Maximum traversal depth. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Render a topology projection of the subtree. ``` flywheel nodes:render:tree --node_id n_abc --projection topology ``` Render a bounded-depth core projection. ``` flywheel nodes:render:tree --node_id n_abc --projection core --max_depth 2 ``` --- # nodes:resolve-slug Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-resolve-slug {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:resolve-slug`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Resolve a slug to a node ID. ## Usage [#usage] ```bash flywheel nodes:resolve-slug ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ------------- | -------- | ------- | ------- | ----------- | | `--slug_name` | `string` | | | Slug text. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--context_node_id` | `string` | | | Disambiguating context node. | | `--detail` | `string` | | | Output detail: compact (default) or full. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Resolve a slug. ``` flywheel nodes:resolve-slug --slug_name my-experiment ``` Return the full node payload when needed. ``` flywheel nodes:resolve-slug --slug_name my-experiment --detail full ``` --- # nodes:sharing:get Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-sharing-get {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:sharing:get`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Get sharing (access policy) for a node. ## Usage [#usage] ```bash flywheel nodes:sharing:get ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ----------- | -------- | ------- | ------- | ---------------- | | `--node_id` | `string` | | | Node identifier. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Read sharing for a node. ``` flywheel nodes:sharing:get --node_id n_abc ``` --- # nodes:sharing:set-bulk Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-sharing-set-bulk {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:sharing:set-bulk`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Apply one sharing policy to multiple nodes. ## Usage [#usage] ```bash flywheel nodes:sharing:set-bulk ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ---------------- | -------- | ------- | ------- | --------------------------------- | | `--node_ids` | `string` | | | Comma-separated node IDs. | | `--sharing_mode` | `string` | | | One of private\|public\|unlisted. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Make two nodes unlisted. ``` flywheel nodes:sharing:set-bulk --node_ids n1,n2 --sharing_mode unlisted ``` --- # nodes:sharing:set Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-sharing-set {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:sharing:set`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Replace sharing (access policy) for a node. ## Usage [#usage] ```bash flywheel nodes:sharing:set ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ---------------- | -------- | ------- | ------- | --------------------------------- | | `--node_id` | `string` | | | Node identifier. | | `--sharing_mode` | `string` | | | One of private\|public\|unlisted. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Set a node public. ``` flywheel nodes:sharing:set --node_id n_abc --sharing_mode public ``` --- # nodes:sharing:summaries Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-sharing-summaries {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:sharing:summaries`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Read access summaries for multiple nodes in one batch. ## Usage [#usage] ```bash flywheel nodes:sharing:summaries ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ------------ | -------- | ------- | ------- | ------------------------- | | `--node_ids` | `string` | | | Comma-separated node IDs. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Batch-read summaries. ``` flywheel nodes:sharing:summaries --node_ids n1,n2,n3 ``` --- # nodes:stage:lease:acquire Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-stage-lease-acquire {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:stage:lease:acquire`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Acquire an edit lease for an existing node. ## Usage [#usage] ```bash flywheel nodes:stage:lease:acquire ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------------------------- | --------- | ------- | ------- | ------------------------------------------------- | | `--node_id` | `string` | | | Target node identifier. | | `--stage_session_id` | `string` | | | Client-provided session identifier for the lease. | | `--base_committed_revision` | `integer` | | | Committed revision the edit is based on. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Acquire a lease before committing a staged edit. ``` flywheel nodes:stage:lease:acquire --node_id n_abc --stage_session_id session-1 --base_committed_revision 7 ``` Acquire a lease using the --key=value long form. ``` flywheel nodes:stage:lease:acquire --node_id=n_abc --stage_session_id=session-2 --base_committed_revision=12 ``` --- # nodes:stage:lease:heartbeat Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-stage-lease-heartbeat {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:stage:lease:heartbeat`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Heartbeat an active node stage lease. ## Usage [#usage] ```bash flywheel nodes:stage:lease:heartbeat ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | -------------------- | -------- | ------- | ------- | ----------------- | | `--node_id` | `string` | | | Node ID. | | `--stage_session_id` | `string` | | | Stage session ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Heartbeat. ``` flywheel nodes:stage:lease:heartbeat --node_id n_abc --stage_session_id s1 ``` --- # nodes:stage:lease:release Canonical URL: https://docs.flywheel.paradigma.inc/cli/nodes-stage-lease-release {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel nodes:stage:lease:release`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Release a node stage lease. ## Usage [#usage] ```bash flywheel nodes:stage:lease:release ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | -------------------- | -------- | ------- | ------- | ----------------- | | `--node_id` | `string` | | | Node ID. | | `--stage_session_id` | `string` | | | Stage session ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Release. ``` flywheel nodes:stage:lease:release --node_id n_abc --stage_session_id s1 ``` --- # profile:list Canonical URL: https://docs.flywheel.paradigma.inc/cli/profile-list {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel profile:list`. ## Command Group [#command-group] Profile Commands ## Summary [#summary] List configured CLI profiles (local only). ## Usage [#usage] ```bash flywheel profile:list [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] List profiles. ``` flywheel profile:list ``` --- # profile:set Canonical URL: https://docs.flywheel.paradigma.inc/cli/profile-set {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel profile:set`. ## Command Group [#command-group] Profile Commands ## Summary [#summary] Create or update a CLI profile (local only; never stores plaintext keys). ## Usage [#usage] ```bash flywheel profile:set ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ------------ | -------- | ------- | ------- | ------------------------ | | `--name` | `string` | | | Profile name. | | `--base_url` | `string` | | | Base URL for the server. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | --------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--api_key_env` | `string` | | | Name of env var that holds the API key at runtime. | | `--api_key_keychain` | | | | If set, the CLI reads the API key from the OS keychain. | | `--default_format` | `string` | | | Output format default (json\|tsv\|csv). | | `--default_timeout_s` | `integer` | | | Default request timeout in seconds. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Create prod profile pointing at FLYWHEEL\_PROD\_API\_KEY. ``` flywheel profile:set --name prod --base_url=https://api.example --api_key_env=FLYWHEEL_PROD_API_KEY ``` --- # profile:show Canonical URL: https://docs.flywheel.paradigma.inc/cli/profile-show {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel profile:show`. ## Command Group [#command-group] Profile Commands ## Summary [#summary] Show a profile definition (local only). ## Usage [#usage] ```bash flywheel profile:show ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | -------- | -------- | ------- | ------- | ------------- | | `--name` | `string` | | | Profile name. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Show prod profile. ``` flywheel profile:show --name prod ``` --- # profile:unset Canonical URL: https://docs.flywheel.paradigma.inc/cli/profile-unset {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel profile:unset`. ## Command Group [#command-group] Profile Commands ## Summary [#summary] Delete a CLI profile (local only). ## Usage [#usage] ```bash flywheel profile:unset ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | -------- | -------- | ------- | ------- | ------------- | | `--name` | `string` | | | Profile name. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Remove a local profile. ``` flywheel profile:unset --name my-local-profile ``` --- # remote-artifacts:refresh Canonical URL: https://docs.flywheel.paradigma.inc/cli/remote-artifacts-refresh {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel remote-artifacts:refresh`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Force refresh a public HTTPS JSON Remote Artifact for a node. ## Usage [#usage] ```bash flywheel remote-artifacts:refresh ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ---------------------- | -------- | ------- | ------- | -------------------------------------- | | `--node_id` | `string` | | | Node ID. | | `--remote_artifact_id` | `string` | | | Stable Remote Artifact ID. | | `--title` | `string` | | | Artifact title. | | `--url` | `string` | | | Public HTTPS JSON URL. | | `--rows_path` | `string` | | | Dotted path resolving to the row list. | | `--row_id` | `string` | | | Dotted path resolving to each row ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | --------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--cache_ttl_seconds` | `integer` | | | Freshness TTL in seconds. Defaults to 60. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Force refresh a Remote Artifact. ``` flywheel remote-artifacts:refresh --node_id n_abc --remote_artifact_id official_leaderboard --title "Official Leaderboard" --url https://example.com/leaderboard.json --rows_path items --row_id github_username ``` --- # remote-artifacts:resolve Canonical URL: https://docs.flywheel.paradigma.inc/cli/remote-artifacts-resolve {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel remote-artifacts:resolve`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Resolve a public HTTPS JSON Remote Artifact for a node. ## Usage [#usage] ```bash flywheel remote-artifacts:resolve ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ---------------------- | -------- | ------- | ------- | -------------------------------------- | | `--node_id` | `string` | | | Node ID. | | `--remote_artifact_id` | `string` | | | Stable Remote Artifact ID. | | `--title` | `string` | | | Artifact title. | | `--url` | `string` | | | Public HTTPS JSON URL. | | `--rows_path` | `string` | | | Dotted path resolving to the row list. | | `--row_id` | `string` | | | Dotted path resolving to each row ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | --------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--cache_ttl_seconds` | `integer` | | | Freshness TTL in seconds. Defaults to 60. | | `--force_refresh` | | | | Bypass the cached artifact when true. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Resolve a Remote Artifact. ``` flywheel remote-artifacts:resolve --node_id n_abc --remote_artifact_id official_leaderboard --title "Official Leaderboard" --url https://example.com/leaderboard.json --rows_path items --row_id github_username ``` --- # setup Canonical URL: https://docs.flywheel.paradigma.inc/cli/setup {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel setup`. ## Command Group [#command-group] Setup Commands ## Summary [#summary] Set up Flywheel for your AI coding host ## Usage [#usage] ```bash flywheel setup [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ----------------- | ------ | ------- | ---------------------------- | -------------------------------------------------------------------------------- | | `--claude` | | | | Set up for Claude Code | | `--cursor` | | | | Set up for Cursor | | `--universal` | | | | Set up for Universal (.agents/skills) | | `--antigravity` | | | | Set up for Antigravity (.agent/skills) | | `--opencode` | | | | Set up for OpenCode | | `--codex` | | | | Set up for Codex | | `--gemini` | | | | Set up for Gemini CLI | | `--pi-mono` | | | | Set up for Pi (pi-mono) | | `--hermes-agent` | | | | Set up for Hermes Agent | | `--openclaw` | | | | Set up for OpenClaw | | `--mode` | `MODE` | | `mcp`, `cli` | Install mode: mcp \| cli | | `--mcp` | | | | Alias for --mode mcp | | `--cli` | | | | Alias for --mode cli | | `-p, --project` | | | | Configure for current project instead of globally | | `-y, --yes` | | | | Skip confirmation prompts | | `--api-key` | `KEY` | | | Use API key authentication | | `--oauth` | | | | Use OAuth endpoint (IDE handles auth flow) | | `--install-skill` | | | | Install or refresh the bundled Flywheel skills | | `--skip-skill` | | | | Skip bundled skill installation (MCP-only setup) | | `--auth-mode` | `MODE` | `auto` | `auto`, `loopback`, `device` | Device approval flow; retired legacy mode returns FLY-416 guidance; default auto | | `--base-url` | `URL` | | | Public Flywheel origin used for setup and MCP config | | `--name` | `NAME` | | | MCP server name | | `--force` | | | | Reconcile prior install mode automatically via uninstall | ## Examples [#examples] Install MCP wiring and bundled skills ``` npx --yes @paradigma-inc/flywheel setup --mode mcp --install-skill ``` Configure Codex MCP wiring without bundled skills ``` npx --yes @paradigma-inc/flywheel setup --mode mcp --skip-skill --codex --project ``` Install CLI-mode bundled skills for Codex ``` npx --yes @paradigma-inc/flywheel setup --mode cli --codex --project ``` --- # tags:assign Canonical URL: https://docs.flywheel.paradigma.inc/cli/tags-assign {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel tags:assign`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Assign or clear tags on a node (atomic replace). ## Usage [#usage] ```bash flywheel tags:assign ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------------------- | --------- | ------- | ------- | -------------------------------- | | `--node_id` | `string` | | | Target node identifier. | | `--tag_ids` | `string` | | | Comma-separated list of tag IDs. | | `--expected_revision` | `integer` | | | Optimistic lock revision. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Assign two tags to a node. ``` flywheel tags:assign --node_id n_abc --tag_ids t1,t2 --expected_revision 22 ``` Clear all tags. ``` flywheel tags:assign --node_id n_abc --tag_ids "" --expected_revision 22 ``` --- # tags:create Canonical URL: https://docs.flywheel.paradigma.inc/cli/tags-create {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel tags:create`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Create a reusable tag on a graph root. ## Usage [#usage] ```bash flywheel tags:create ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------------------- | --------- | ------- | ------- | --------------------------------------------- | | `--root_node_id` | `string` | | | Root node (graph) identifier. | | `--name` | `string` | | | Tag display name. | | `--expected_revision` | `integer` | | | Root revision to optimistically lock against. | | `--bg_color` | `string` | | | Background color (e.g. #ff0000). | | `--text_color` | `string` | | | Foreground text color (e.g. #ffffff). | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--one_only` | | | | Enforce at most one assignment of this tag per node. | | `--track_history` | | | | Keep a history record when this one\_only tag is reassigned. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Create a new tag with colors. ``` flywheel tags:create --root_node_id r_root --name urgent --expected_revision 12 --bg_color "#ff0000" --text_color "#ffffff" ``` --- # tags:delete Canonical URL: https://docs.flywheel.paradigma.inc/cli/tags-delete {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel tags:delete`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Delete a tag definition from the graph. ## Usage [#usage] ```bash flywheel tags:delete ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------------------- | --------- | ------- | ------- | ------------------------- | | `--root_node_id` | `string` | | | Graph root identifier. | | `--tag_id` | `string` | | | Tag identifier. | | `--expected_revision` | `integer` | | | Optimistic lock revision. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Delete a tag. ``` flywheel tags:delete --root_node_id r_root --tag_id t_abc --expected_revision 14 ``` --- # tags:update Canonical URL: https://docs.flywheel.paradigma.inc/cli/tags-update {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel tags:update`. ## Command Group [#command-group] Nodes & Graph Commands ## Summary [#summary] Update a tag definition. ## Usage [#usage] ```bash flywheel tags:update ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | --------------------- | --------- | ------- | ------- | ------------------------- | | `--root_node_id` | `string` | | | Graph root identifier. | | `--tag_id` | `string` | | | Tag identifier. | | `--expected_revision` | `integer` | | | Optimistic lock revision. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--name` | `string` | | | New tag name. | | `--bg_color` | `string` | | | New background color. | | `--text_color` | `string` | | | New foreground text color. | | `--one_only` | | | | Toggle at-most-one-per-node constraint. | | `--track_history` | | | | Toggle history tracking for one\_only tags. | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Rename a tag. ``` flywheel tags:update --root_node_id r_root --tag_id t_abc --expected_revision 13 --name urgent-v2 ``` --- # uninstall Canonical URL: https://docs.flywheel.paradigma.inc/cli/uninstall {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel uninstall`. ## Command Group [#command-group] Setup Commands ## Summary [#summary] Remove Flywheel MCP entries and bundled skills from selected hosts ## Usage [#usage] ```bash flywheel uninstall [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ---------------- | ------- | ------- | -------------------------- | -------------------------------------------- | | `--claude` | | | | Uninstall for Claude Code | | `--cursor` | | | | Uninstall for Cursor | | `--universal` | | | | Uninstall bundled skills from .agents/skills | | `--antigravity` | | | | Uninstall bundled skills from .agent/skills | | `--opencode` | | | | Uninstall for OpenCode | | `--codex` | | | | Uninstall for Codex | | `--gemini` | | | | Uninstall for Gemini CLI | | `--pi-mono` | | | | Uninstall for Pi (pi-mono) | | `--hermes-agent` | | | | Uninstall for Hermes Agent | | `--openclaw` | | | | Uninstall for OpenClaw | | `--hosts` | `LIST` | | | Comma-separated host list | | `--scope` | `SCOPE` | | `all`, `global`, `project` | all \| global \| project | | `--name` | `NAME` | | | MCP server name to remove | | `-y, --yes` | | | | Skip uninstall selection prompts | ## Examples [#examples] Uninstall Codex project-scope artifacts ``` npx --yes @paradigma-inc/flywheel uninstall --codex --scope project ``` Uninstall selected hosts across all scopes ``` npx --yes @paradigma-inc/flywheel uninstall --hosts claude,codex --scope all --yes ``` --- # update Canonical URL: https://docs.flywheel.paradigma.inc/cli/update {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel update`. ## Command Group [#command-group] Other Commands ## Summary [#summary] Update the local Flywheel CLI package and setup artifacts ## Usage [#usage] ```bash flywheel update [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ----------- | ----- | ------- | ------- | ---------------------------------------------------- | | `--check` | | | | Print installed/latest status without changing files | | `--dry-run` | | | | Print planned package and local setup refresh steps | | `--yes` | | | | Run prompt-free for agent execution | ## Examples [#examples] Update the Flywheel CLI and refresh local setup ``` flywheel update --yes ``` Check whether a newer public package is available ``` flywheel update --check ``` Preview update and refresh steps ``` flywheel update --dry-run ``` --- # updates:hide-all-active Canonical URL: https://docs.flywheel.paradigma.inc/cli/updates-hide-all-active {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel updates:hide-all-active`. ## Command Group [#command-group] Updates & Resources Commands ## Summary [#summary] Hide all currently active announcements. ## Usage [#usage] ```bash flywheel updates:hide-all-active [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Hide all. ``` flywheel updates:hide-all-active ``` --- # updates:hide Canonical URL: https://docs.flywheel.paradigma.inc/cli/updates-hide {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel updates:hide`. ## Command Group [#command-group] Updates & Resources Commands ## Summary [#summary] Hide a specific announcement. ## Usage [#usage] ```bash flywheel updates:hide ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ------------------- | -------- | ------- | ------- | ---------------- | | `--announcement_id` | `string` | | | Announcement ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Hide. ``` flywheel updates:hide --announcement_id a_abc ``` --- # updates:list Canonical URL: https://docs.flywheel.paradigma.inc/cli/updates-list {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel updates:list`. ## Command Group [#command-group] Updates & Resources Commands ## Summary [#summary] List in-app announcements relevant to your account. ## Usage [#usage] ```bash flywheel updates:list [FLAGS] ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--page` | `integer` | | | Page number. | | `--page_size` | `integer` | | | Page size (canonical). | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] List updates. ``` flywheel updates:list --page 1 --page_size 20 ``` --- # updates:unhide Canonical URL: https://docs.flywheel.paradigma.inc/cli/updates-unhide {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel updates:unhide`. ## Command Group [#command-group] Updates & Resources Commands ## Summary [#summary] Restore a previously hidden announcement. ## Usage [#usage] ```bash flywheel updates:unhide ``` ## Required flags [#required-flags] | Flag | Value | Default | Choices | Description | | ------------------- | -------- | ------- | ------- | ---------------- | | `--announcement_id` | `string` | | | Announcement ID. | ## Optional flags [#optional-flags] | Flag | Value | Default | Choices | Description | | ------------------- | --------- | ------- | ----------------------------- | -------------------------------------------------------------------------------------- | | `--format` | `FORMAT` | | `json`, `tsv`, `csv`, `table` | Output format for command results. | | `--env` | `PROFILE` | | | Use a configured CLI profile for this invocation. | | `--out` | `PATH` | | | Write output to a file path, or use - for stdout. | | `--open` | | | | Open browser-bound URLs when supported. | | `--no-retry` | | | | Disable transient-error retries. | | `--retry-max` | `N` | | | Maximum transient-error retry attempts. | | `--wait` | | | | Block on async operations until a terminal state is reached. | | `--wait-timeout` | `SECONDS` | `600` | | Seconds to wait for --wait before timing out. Defaults to 600. | | `--allow-self` | | | | Allow mutating the currently active credential. | | `--timeout` | `SECONDS` | | | Set the per-request timeout budget in seconds. | | `--idempotency-key` | `KEY` | | | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | | `--force` | | | | Force safety-gated operations where supported. | | `--yes` | | | | Skip confirmation prompts for destructive operations. | | `--debug` | | | | Print structured request debugging with secrets masked. | | `--verbose` | | | | Print verbose progress for long-running operations. | | `-h, --help` | | | | Show this help. | ## Examples [#examples] Unhide. ``` flywheel updates:unhide --announcement_id a_abc ``` --- # version Canonical URL: https://docs.flywheel.paradigma.inc/cli/version {/* This file was generated by scripts/generate-cli-pages.ts. Do not edit directly; update content/cli-copy/commands.json or regenerate the CLI docs. */} Reference for `flywheel version`. ## Command Group [#command-group] Setup Commands ## Summary [#summary] Print the Flywheel CLI version. ## Usage [#usage] ```bash flywheel version ``` ## Required flags [#required-flags] None. ## Optional flags [#optional-flags] None. ## Examples [#examples] No examples are declared in the Usage source. --- # Encoding the Scientific Method Canonical URL: https://docs.flywheel.paradigma.inc/how-to-use-flywheel/encoding-the-scientific-method For research work, we strongly recommend treating Flywheel nodes as evidence-backed hypotheses, claims, questions, or intermediate conclusions. Flywheel does not require a special field for that structure. Put the reasoning in Markdown, attach the evidence that supports or rejects it, and use the graph to keep competing explanations visible at the same time. This gives you a flexible schema without losing the discipline of the scientific method. A node can still be a plain note, dataset record, operational checkpoint, or reading log when that is the right shape. When the node is making a research claim, default to evidence-backed writing. ## The recommendation [#the-recommendation] Use each claim-bearing node to answer four questions: * What hypothesis, claim, or question is this node about? * What evidence currently supports it? * What evidence currently argues against it? * What should happen next? Map those answers to Flywheel primitives: * Use node content for the hypothesis, reasoning, caveats, and next steps. * Use the summary as the current read, especially after new evidence lands. * Use artifacts for concrete evidence such as logs, tables, plots, reports, diffs, checkpoints, benchmark outputs, and source excerpts. * Use executions for runs that generated evidence or tested a claim. * Use tags for research state such as `open`, `supported`, `rejected`, `needs-replication`, or `blocked`. * Use graph edges and branches for competing hypotheses, refinements, and follow-up experiments. ## A node as a hypothesis [#a-node-as-a-hypothesis] A useful research node is usually written as a small argument, not just a title. Keep the central claim near the top, then separate evidence for and against it. ```md ## Hypothesis State the claim or question being tested. ## Evidence for - Link or summarize observations that support the claim. - Attach durable artifacts for anything empirical. ## Evidence against - Note failed runs, counterexamples, uncertainty, and alternative explanations. - Attach the evidence even when it weakens the claim. ## Current read Say what you currently believe and how strongly. ## Next step Name the next experiment, branch, review, or decision. ``` The template is a default for research claims, not a required format for every node. The important part is that another person can inspect the node later and see the claim, the evidence, the counterevidence, and the next decision point. ## Evidence for and against [#evidence-for-and-against] Attach evidence as artifacts instead of burying it in prose. Prose can explain why the evidence matters, but the durable output should stay inspectable: * Tables and CSVs for measurements. * Plots and images for visual inspection. * Logs and transcripts for execution traces. * Reports and notebooks for analysis. * Diffs and patches for code changes. * Checkpoints and model outputs for reproducibility. When evidence changes your view, update the summary. The content can preserve the longer reasoning trail, while the summary gives readers the latest read without requiring them to reprocess the whole node. ## Competing hypotheses as branches [#competing-hypotheses-as-branches] When there are multiple plausible explanations, branch them explicitly. Start from a shared observation or question, then create child nodes for each candidate explanation. For example: * Parent: `Why did benchmark accuracy drop?` * Branch A: `The data loader changed sample ordering.` * Branch B: `The new prompt increases invalid outputs.` * Branch C: `The evaluation script changed normalization.` Attach evidence to each branch as work proceeds. A branch can become supported, rejected, merged into another explanation, or kept open for more work. This is usually clearer than keeping several mutually exclusive claims inside one long node. ## Tags and summaries [#tags-and-summaries] Use tags for state that needs to be scanned or filtered. Use summaries for the current interpretation. Keep the longer Markdown content as the audit trail. Good tags are short and operational: * `open` * `supported` * `rejected` * `needs-evidence` * `needs-replication` * `blocked` Avoid making tags carry the whole argument. If the state is complex, write it in the summary and point to the artifacts or child nodes that justify it. ## What not to do [#what-not-to-do] Avoid these patterns: * One large node that holds several competing hypotheses. * A research claim with no attached evidence. * Evidence that exists only as a sentence in Markdown when there is a concrete artifact available. * State that only lives in old prose after the summary or tags have moved on. * Branches that duplicate the same claim without a distinct question, experiment, or counterargument. Flywheel works best when the graph shows the shape of the investigation, the content explains the reasoning, and the artifacts preserve the evidence. --- # MCP Canonical URL: https://docs.flywheel.paradigma.inc/mcp Flywheel exposes MCP tools so compatible agent hosts can create nodes, inspect graphs, attach artifacts, manage hooks, and launch supported workflows without shelling out to a CLI. The MCP endpoint is: ```text https://flywheel.paradigma.inc/mcp-server ``` MCP access uses the same Flywheel product boundary as the HTTP API and Web UI. For local host wiring, start with [MCP setup](/mcp/setup). For direct command usage, see the [CLI reference](/cli). --- # MCP Setup Canonical URL: https://docs.flywheel.paradigma.inc/mcp/setup Use the installer in MCP mode for local host wiring: ```bash curl -fsSL https://flywheel.paradigma.inc/install | sh -s -- --mode mcp ``` Setup installs the Flywheel runtime, writes host config for supported MCP clients, and installs bundled Flywheel skills where the host supports them. Use this path when you want your agent to call Flywheel tools directly instead of shelling out to `flywheel` commands. On Windows, run setup in the same environment that launches your host. Use WSL for WSL-launched hosts and native PowerShell for native Windows hosts; the two environments write separate host config files. In native PowerShell, use npm/npx instead of the POSIX shell installer: ```powershell npx --yes @paradigma-inc/flywheel@latest setup --mode mcp ``` For web connector hosts, use the host-native connector UI and provide: ```text https://flywheel.paradigma.inc/mcp-server ``` For remote shells, use device auth: ```bash curl -fsSL https://flywheel.paradigma.inc/install | sh -s -- \ --mode mcp \ --auth-mode device \ --base-url https://flywheel.paradigma.inc ``` Device auth prints an approval URL and setup code, then polls until the API key is issued. It is the right choice when the browser that completes auth is not running on the same machine as the installer. If browser auth does not open from WSL, copy the printed approval URL and setup code into your Windows browser. ## Verify Setup [#verify-setup] After setup, confirm both the CLI and your host can see Flywheel: ```bash flywheel auth:status flywheel help ``` Then ask your MCP host to list available tools. You should see Flywheel tool names such as graph, artifact, hook, and compute operations. If the host cannot see them, use [MCP troubleshooting](/mcp/troubleshooting) and confirm the configured server URL is exactly `https://flywheel.paradigma.inc/mcp-server`. For setup flags and uninstall flags, see the generated [CLI reference](/cli). --- # MCP Tools Canonical URL: https://docs.flywheel.paradigma.inc/mcp/tools Flywheel MCP tools are grouped by workflow area: * Graph and node creation. * Node inspection and summarization. * Artifact publish and retrieval. * Hook and automation management. * Managed compute workflows. * Import, export, and sharing workflows. For conceptual hook guidance, see [Hooks And Automations](/concepts/hooks). For exact hook inputs and outputs, call `flywheel_get_contract_section` with the hooks section or inspect the generated hook API reference. Hook definitions declare one or more events in `workflow_yaml.on`; supported events are `artifact.finalized` and `node.published`. For exact tool inputs and outputs, call `flywheel_get_contract` from your MCP host. Use `flywheel_get_contract_section` for focused sections such as graph, artifacts, hooks, compute, import/export, and campaign workflows. When participating in a campaign, treat `metadata.campaign_role = "submission"` as the marker for the artifact that should be accepted by the campaign. Read the campaign config before finalizing it. If the config declares `submission_policy.required_visibility = "public"`, make the attempt node public first; private drafts should remain ordinary artifacts without the submission role. After a valid submission artifact is finalized, Flywheel creates a campaign submission lifecycle record. Use `flywheel_get_artifact_campaign_submission` to check the status for a known node/artifact pair, `flywheel_list_node_campaign_submissions` to list statuses for an attempt node, or `flywheel_get_campaign_submission` when you already have the submission id. Invalid submissions return `422` during finalization and do not create lifecycle records. `forwarded` means Flywheel handed the submission to campaign automation; terminal states are `scored`, `rejected`, and `failed`. Mutating tools can return HTTP `429` when a user exceeds write limits. See [Usage Limits](/concepts/usage-limits) for the current limits and retry behavior. --- # MCP Troubleshooting Canonical URL: https://docs.flywheel.paradigma.inc/mcp/troubleshooting If a host cannot see Flywheel tools, first confirm the host supports MCP and that setup completed successfully. ```bash flywheel auth:status flywheel help ``` If a web connector cannot connect, confirm the configured connector URL is: ```text https://flywheel.paradigma.inc/mcp-server ``` --- # Get Blob Canonical URL: https://docs.flywheel.paradigma.inc/api/blobs/get_blob_v1_blobs__key__get Download a blob by key, if it belongs to the current user. Method: `GET` Path: `/v1/blobs/{key}` Tags: `blobs` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | key | path | yes | string | | ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Auth Status Canonical URL: https://docs.flywheel.paradigma.inc/api/api/auth_status_v1_auth_status_get Check authentication and session-capacity status. Method: `GET` Path: `/v1/auth/status` Tags: `api` ## Responses ### 200 Successful Response - `application/json`: object --- # Claim Referral Code Canonical URL: https://docs.flywheel.paradigma.inc/api/credits/claim_referral_code_v1_credits_referral_claim_post Claim referral rewards for inviter and invitee. Method: `POST` Path: `/v1/credits/referral/claim` Tags: `credits` ## Request Body Required: yes - `application/json`: ReferralClaimRequest ## Responses ### 200 Successful Response - `application/json`: ReferralClaimResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get Credits Canonical URL: https://docs.flywheel.paradigma.inc/api/credits/get_credits_v1_credits_get Get the current user's credit balance. Method: `GET` Path: `/v1/credits` Tags: `credits` ## Responses ### 200 Successful Response - `application/json`: UserCreditsResponse --- # Get Referral Overview Canonical URL: https://docs.flywheel.paradigma.inc/api/credits/get_referral_overview_v1_credits_referral_get Get referral code and current referral-beta stats for this user. Method: `GET` Path: `/v1/credits/referral` Tags: `credits` ## Responses ### 200 Successful Response - `application/json`: ReferralOverviewResponse --- # Get Subscription Status Canonical URL: https://docs.flywheel.paradigma.inc/api/credits/get_subscription_status_v1_credits_subscription_get Get subscription status for the authenticated user. Method: `GET` Path: `/v1/credits/subscription` Tags: `credits` ## Responses ### 200 Successful Response - `application/json`: SubscriptionStatusResponse --- # Get Transactions Canonical URL: https://docs.flywheel.paradigma.inc/api/credits/get_transactions_v1_credits_transactions_get Get the user's credit transaction history. Method: `GET` Path: `/v1/credits/transactions` Tags: `credits` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | limit | query | no | integer default: 50 | | | offset | query | no | integer default: 0 | | ## Responses ### 200 Successful Response - `application/json`: TransactionListResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get Usage Canonical URL: https://docs.flywheel.paradigma.inc/api/credits/get_usage_v1_credits_usage_get Get the current user's API usage breakdown. Returns usage aggregated by feature (assistant, engineer) for the specified time period. Method: `GET` Path: `/v1/credits/usage` Tags: `credits` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | days | query | no | integer default: 30 | | ## Responses ### 200 Successful Response - `application/json`: UsageBreakdownResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Create Feedback Canonical URL: https://docs.flywheel.paradigma.inc/api/feedback/create_feedback_v1_feedback_post Flywheel public documentation page. Method: `POST` Path: `/v1/feedback` Tags: `feedback` ## Request Body Required: yes - `application/json`: object ## Responses ### 201 Successful Response - `application/json`: Response Create Feedback V1 Feedback Post ### 422 Validation Error - `application/json`: HTTPValidationError --- # Approve Mcp Api Key Setup Device Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp-api-keys/approve_mcp_api_key_setup_device_v1_auth_mcp_api_keys_setup_device_approve_post Flywheel public documentation page. Method: `POST` Path: `/v1/auth/mcp-api-keys/setup-device/approve` Tags: `mcp-api-keys` ## Request Body Required: yes - `application/json`: ApproveMcpSetupDeviceRequest ## Responses ### 200 Successful Response - `application/json`: ApproveMcpSetupDeviceResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Delete Mcp Api Key Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp-api-keys/delete_mcp_api_key_v1_auth_mcp_api_keys__key_id__delete Flywheel public documentation page. Method: `DELETE` Path: `/v1/auth/mcp-api-keys/{key_id}` Tags: `mcp-api-keys` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | key_id | path | yes | string | | ## Responses ### 200 Successful Response - `application/json`: DeleteMcpApiKeyResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Issue Mcp Api Key Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp-api-keys/issue_mcp_api_key_v1_auth_mcp_api_keys_post Flywheel public documentation page. Method: `POST` Path: `/v1/auth/mcp-api-keys` Tags: `mcp-api-keys` ## Request Body Required: yes - `application/json`: CreateMcpApiKeyRequest ## Responses ### 200 Successful Response - `application/json`: CreateMcpApiKeyResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # List Mcp Api Keys Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp-api-keys/list_mcp_api_keys_v1_auth_mcp_api_keys_get Flywheel public documentation page. Method: `GET` Path: `/v1/auth/mcp-api-keys` Tags: `mcp-api-keys` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | limit | query | no | integer \| null | | | offset | query | no | integer default: 0 | | ## Responses ### 200 Successful Response - `application/json`: ListMcpApiKeysResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Poll Mcp Api Key Setup Device Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp-api-keys/poll_mcp_api_key_setup_device_v1_auth_mcp_api_keys_setup_device_poll_post Flywheel public documentation page. Method: `POST` Path: `/v1/auth/mcp-api-keys/setup-device/poll` Tags: `mcp-api-keys` ## Request Body Required: yes - `application/json`: PollMcpSetupDeviceRequest ## Responses ### 200 Successful Response - `application/json`: PollMcpSetupDeviceResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Rotate Mcp Api Key Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp-api-keys/rotate_mcp_api_key_v1_auth_mcp_api_keys__key_id__rotate_post Flywheel public documentation page. Method: `POST` Path: `/v1/auth/mcp-api-keys/{key_id}/rotate` Tags: `mcp-api-keys` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | key_id | path | yes | string | | ## Request Body Required: yes - `application/json`: RotateMcpApiKeyRequest ## Responses ### 200 Successful Response - `application/json`: RotateMcpApiKeyResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Start Mcp Api Key Setup Device Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp-api-keys/start_mcp_api_key_setup_device_v1_auth_mcp_api_keys_setup_device_start_post Flywheel public documentation page. Method: `POST` Path: `/v1/auth/mcp-api-keys/setup-device/start` Tags: `mcp-api-keys` ## Request Body Required: yes - `application/json`: CreateMcpSetupDeviceStartRequest ## Responses ### 200 Successful Response - `application/json`: CreateMcpSetupDeviceStartResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Acquire Stage Lease Endpoint Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/acquire_stage_lease_endpoint_v1_nodes__node_id__stage_lease_acquire_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{node_id}/stage/lease/acquire` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpStageLeaseAcquireRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Add Parent Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/add_parent_v1_nodes__node_id__parents_add_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{node_id}/parents/add` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpAddParentRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Approval Session Expire Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/approval_session_expire_v1_approval_sessions_expire_post Flywheel public documentation page. Method: `POST` Path: `/v1/approval-sessions/expire` Tags: `mcp` ## Request Body Required: yes - `application/json`: McpApprovalSessionExpireRequest ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Approval Session Heartbeat Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/approval_session_heartbeat_v1_approval_sessions_heartbeat_post Flywheel public documentation page. Method: `POST` Path: `/v1/approval-sessions/heartbeat` Tags: `mcp` ## Request Body Required: yes - `application/json`: McpApprovalSessionHeartbeatRequest ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Approval Session Open Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/approval_session_open_v1_approval_sessions_open_post Flywheel public documentation page. Method: `POST` Path: `/v1/approval-sessions/open` Tags: `mcp` ## Request Body Required: yes - `application/json`: McpApprovalSessionOpenRequest ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Bulk Delete Artifacts Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/bulk_delete_artifacts_v1_nodes__node_id__artifacts_bulk_delete_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{node_id}/artifacts/bulk-delete` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpBulkDeleteArtifactsRequest ## Responses ### 200 Successful Response - `application/json`: McpBulkDeleteArtifactsResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Campaign Budgets Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/campaign_budgets_v1_nodes__root_node_id__campaign_budgets_get Flywheel public documentation page. Method: `GET` Path: `/v1/nodes/{root_node_id}/campaign-budgets` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | root_node_id | path | yes | string | | | status | query | no | string \| null | | | limit | query | no | integer default: 20 | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Commit New Node Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/commit_new_node_v1_nodes_commit_new_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/commit-new` Tags: `mcp` ## Request Body Required: yes - `application/json`: McpCommitNewNodeRequest ## Responses ### 201 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Commit Node Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/commit_node_v1_nodes__node_id__commit_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{node_id}/commit` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpCommitNodeRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Compute Acquire Node Scoped Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/compute_acquire_node_scoped_v1_nodes__node_id__compute_acquire_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{node_id}/compute/acquire` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpComputeAcquireRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Compute Catalog Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/compute_catalog_v1_compute_catalog_get Flywheel public documentation page. Method: `GET` Path: `/v1/compute/catalog` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | query | no | string \| null | | | provider | query | no | string \| null | | | region | query | no | string \| null | | | limit | query | no | integer default: 25 | | | detail | query | no | string enum: "compact", "full" default: "compact" | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Compute Connection Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/compute_connection_v1_compute_connection_get Flywheel public documentation page. Method: `GET` Path: `/v1/compute/connection` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | query | no | string \| null | | | provider | query | no | string \| null | | | lease_control_token | query | yes | string | | | lease_id | query | no | string \| null | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Compute Funding Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/compute_funding_v1_compute_funding_get Flywheel public documentation page. Method: `GET` Path: `/v1/compute/funding` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | compute_grant_id | query | yes | string | | | approval_session_id | query | no | string \| null | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Compute Grants Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/compute_grants_v1_compute_grants_get Flywheel public documentation page. Method: `GET` Path: `/v1/compute/grants` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | budget_source | query | no | string \| null | | | status | query | no | string \| null | | | approval_session_id | query | no | string \| null | | | limit | query | no | integer default: 20 | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Create Campaign Budget Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/create_campaign_budget_v1_nodes__root_node_id__campaign_budgets_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{root_node_id}/campaign-budgets` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | root_node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpCampaignComputeBudgetCreateRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Delete Artifact Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/delete_artifact_v1_nodes__node_id__artifacts__artifact_id__delete Flywheel public documentation page. Method: `DELETE` Path: `/v1/nodes/{node_id}/artifacts/{artifact_id}` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | | artifact_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpDeleteArtifactRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Finalize Artifact Uploads Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/finalize_artifact_uploads_v1_nodes__node_id__artifacts_uploads_finalize_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{node_id}/artifacts/uploads/finalize` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpFinalizeArtifactUploadsRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get Artifact Campaign Submission Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/get_artifact_campaign_submission_v1_nodes__node_id__artifacts__artifact_id__campaign_submission_get Flywheel public documentation page. Method: `GET` Path: `/v1/nodes/{node_id}/artifacts/{artifact_id}/campaign-submission` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | | artifact_id | path | yes | string | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get Campaign Snapshot Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/get_campaign_snapshot_v1_nodes__node_id__campaign_snapshot_get Flywheel public documentation page. Method: `GET` Path: `/v1/nodes/{node_id}/campaign/snapshot` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get Campaign Submission Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/get_campaign_submission_v1_campaign_submissions__submission_id__get Flywheel public documentation page. Method: `GET` Path: `/v1/campaign-submissions/{submission_id}` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | submission_id | path | yes | string | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get Contract Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/get_contract_mcp_contract_get Flywheel public documentation page. Method: `GET` Path: `/mcp/contract` Tags: `mcp` ## Responses ### 200 Successful Response - `application/json`: object --- # Get Contract Section Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/get_contract_section_mcp_contract_sections__section_id__get Flywheel public documentation page. Method: `GET` Path: `/mcp/contract/sections/{section_id}` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | section_id | path | yes | string | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get Node Ancestry Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/get_node_ancestry_v1_nodes__node_id__ancestry_get Flywheel public documentation page. Method: `GET` Path: `/v1/nodes/{node_id}/ancestry` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | | max_depth | query | no | integer default: 256 | | | projection | query | no | string enum: "full", "topology", "core" default: "topology" | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Heartbeat Stage Lease Endpoint Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/heartbeat_stage_lease_endpoint_v1_nodes__node_id__stage_lease_heartbeat_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{node_id}/stage/lease/heartbeat` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpStageLeaseHeartbeatRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Launch Execution Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/launch_execution_v1_nodes__node_id__executions_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{node_id}/executions` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpLaunchExecutionRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # List Approval Sessions Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/list_approval_sessions_v1_approval_sessions_get Flywheel public documentation page. Method: `GET` Path: `/v1/approval-sessions` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | status | query | no | string enum: "active", "expired" \| null | | | limit | query | no | integer default: 20 | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # List Executions Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/list_executions_v1_nodes__node_id__executions_get Flywheel public documentation page. Method: `GET` Path: `/v1/nodes/{node_id}/executions` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # List Node Campaign Submissions Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/list_node_campaign_submissions_v1_nodes__node_id__campaign_submissions_get Flywheel public documentation page. Method: `GET` Path: `/v1/nodes/{node_id}/campaign-submissions` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | | state | query | no | string \| null | | | limit | query | no | integer default: 100 | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Mcp Create Hook Secret Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/mcp_create_hook_secret_v1_nodes__owner_node_id__hook_secrets_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{owner_node_id}/hook-secrets` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | owner_node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: HookCreateSecretRequest ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Mcp Create Hook Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/mcp_create_hook_v1_nodes__owner_node_id__hooks_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{owner_node_id}/hooks` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | owner_node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: Payload ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Mcp Delete Hook Secret Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/mcp_delete_hook_secret_v1_nodes__owner_node_id__hook_secrets__secret_id__delete Flywheel public documentation page. Method: `DELETE` Path: `/v1/nodes/{owner_node_id}/hook-secrets/{secret_id}` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | owner_node_id | path | yes | string | | | secret_id | path | yes | string | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Mcp Delete Hook Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/mcp_delete_hook_v1_nodes__owner_node_id__hooks__hook_id__delete Flywheel public documentation page. Method: `DELETE` Path: `/v1/nodes/{owner_node_id}/hooks/{hook_id}` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | owner_node_id | path | yes | string | | | hook_id | path | yes | string | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Mcp List Hook Runs Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/mcp_list_hook_runs_v1_nodes__owner_node_id__hook_runs_get Flywheel public documentation page. Method: `GET` Path: `/v1/nodes/{owner_node_id}/hook-runs` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | owner_node_id | path | yes | string | | | hook_id | query | no | string \| null | | | limit | query | no | integer default: 100 | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Mcp List Hook Secrets Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/mcp_list_hook_secrets_v1_nodes__owner_node_id__hook_secrets_get Flywheel public documentation page. Method: `GET` Path: `/v1/nodes/{owner_node_id}/hook-secrets` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | owner_node_id | path | yes | string | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Mcp List Hooks Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/mcp_list_hooks_v1_nodes__owner_node_id__hooks_get Flywheel public documentation page. Method: `GET` Path: `/v1/nodes/{owner_node_id}/hooks` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | owner_node_id | path | yes | string | | | include_disabled | query | no | boolean default: true | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Mcp Set Hook Enabled Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/mcp_set_hook_enabled_v1_nodes__owner_node_id__hooks__hook_id__enabled_patch Flywheel public documentation page. Method: `PATCH` Path: `/v1/nodes/{owner_node_id}/hooks/{hook_id}/enabled` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | owner_node_id | path | yes | string | | | hook_id | path | yes | string | | ## Request Body Required: yes - `application/json`: HookSetEnabledRequest ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Mcp Update Hook Secret Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/mcp_update_hook_secret_v1_nodes__owner_node_id__hook_secrets__secret_id__patch Flywheel public documentation page. Method: `PATCH` Path: `/v1/nodes/{owner_node_id}/hook-secrets/{secret_id}` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | owner_node_id | path | yes | string | | | secret_id | path | yes | string | | ## Request Body Required: yes - `application/json`: HookUpdateSecretRequest ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Mcp Update Hook Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/mcp_update_hook_v1_nodes__owner_node_id__hooks__hook_id__patch Flywheel public documentation page. Method: `PATCH` Path: `/v1/nodes/{owner_node_id}/hooks/{hook_id}` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | owner_node_id | path | yes | string | | | hook_id | path | yes | string | | ## Request Body Required: yes - `application/json`: Payload ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Prepare Artifact Uploads Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/prepare_artifact_uploads_v1_nodes__node_id__artifacts_uploads_prepare_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{node_id}/artifacts/uploads/prepare` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpPrepareArtifactUploadsRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Refresh Remote Artifact Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/refresh_remote_artifact_v1_nodes__node_id__remote_artifacts_refresh_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{node_id}/remote-artifacts/refresh` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpRemoteArtifactRequest ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Release Stage Lease Endpoint Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/release_stage_lease_endpoint_v1_nodes__node_id__stage_lease_release_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{node_id}/stage/lease/release` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpStageLeaseReleaseRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Remove Parent Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/remove_parent_v1_nodes__node_id__parents_remove_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{node_id}/parents/remove` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpRemoveParentRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Request Compute Grant Approval Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/request_compute_grant_approval_v1_compute_grants_request_approval_post Consolidated approval request endpoint. Orchestrates approval-session heartbeat, grants listing, credits / campaign-budget preflight and optional compute-status probe so the CLI can drop its multi-endpoint wrapper. Method: `POST` Path: `/v1/compute-grants/request-approval` Tags: `mcp` ## Request Body Required: yes - `application/json`: McpRequestComputeGrantApprovalRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Resolve Remote Artifact Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/resolve_remote_artifact_v1_nodes__node_id__remote_artifacts_resolve_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{node_id}/remote-artifacts/resolve` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpRemoteArtifactRequest ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Revoke Campaign Budget Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/revoke_campaign_budget_v1_nodes__root_node_id__campaign_budgets__compute_budget_id__delete Flywheel public documentation page. Method: `DELETE` Path: `/v1/nodes/{root_node_id}/campaign-budgets/{compute_budget_id}` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | root_node_id | path | yes | string | | | compute_budget_id | path | yes | string | | ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Set Artifact Note Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/set_artifact_note_v1_nodes__node_id__artifacts__artifact_id__note_patch Flywheel public documentation page. Method: `PATCH` Path: `/v1/nodes/{node_id}/artifacts/{artifact_id}/note` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | | artifact_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpSetArtifactNoteRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Summarize Node Tree Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/summarize_node_tree_v1_nodes__node_id__summary_get Flywheel public documentation page. Method: `GET` Path: `/v1/nodes/{node_id}/summary` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | | max_nodes | query | no | integer default: 200 | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Terminate Execution Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/terminate_execution_v1_nodes__node_id__executions__execution_id__terminate_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{node_id}/executions/{execution_id}/terminate` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | | execution_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpTerminateExecutionRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Update Campaign Budget Canonical URL: https://docs.flywheel.paradigma.inc/api/mcp/update_campaign_budget_v1_nodes__root_node_id__campaign_budgets__compute_budget_id__patch Flywheel public documentation page. Method: `PATCH` Path: `/v1/nodes/{root_node_id}/campaign-budgets/{compute_budget_id}` Tags: `mcp` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | root_node_id | path | yes | string | | | compute_budget_id | path | yes | string | | ## Request Body Required: yes - `application/json`: McpCampaignComputeBudgetUpdateRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get Compute Status Canonical URL: https://docs.flywheel.paradigma.inc/api/resources/get_compute_status_v1_compute_status_get Flywheel public documentation page. Method: `GET` Path: `/v1/compute/status` Tags: `resources` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | provider | query | no | string \| null | | | lease_control_token | query | yes | string | | | compute_grant_id | query | no | string \| null | | | limit | query | no | integer default: 20 | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get Node Files Canonical URL: https://docs.flywheel.paradigma.inc/api/resources/get_node_files_v1_nodes__node_id__files_get Flywheel public documentation page. Method: `GET` Path: `/v1/nodes/{node_id}/files` Tags: `resources` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Responses ### 200 Successful Response - `application/json`: NodeFilesResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get User Files Canonical URL: https://docs.flywheel.paradigma.inc/api/resources/get_user_files_v1_users_me_files_get Flywheel public documentation page. Method: `GET` Path: `/v1/users/me/files` Tags: `resources` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | page | query | no | string \| null | | | page_size | query | no | string \| null | | ## Responses ### 200 Successful Response - `application/json`: UserFilesResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get User Machines Canonical URL: https://docs.flywheel.paradigma.inc/api/resources/get_user_machines_v1_users_me_machines_get Flywheel public documentation page. Method: `GET` Path: `/v1/users/me/machines` Tags: `resources` ## Responses ### 200 Successful Response - `application/json`: UserMachinesResponse --- # Release All User Machine Leases Canonical URL: https://docs.flywheel.paradigma.inc/api/resources/release_all_user_machine_leases_v1_users_me_machines_release_all_post Flywheel public documentation page. Method: `POST` Path: `/v1/users/me/machines/release-all` Tags: `resources` ## Request Body Required: yes - `application/json`: ReleaseMachineLeaseRequest ## Responses ### 200 Successful Response - `application/json`: UserMachineBulkReleaseResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Release User Machine Lease Canonical URL: https://docs.flywheel.paradigma.inc/api/resources/release_user_machine_lease_v1_users_me_machines__lease_id__release_post Flywheel public documentation page. Method: `POST` Path: `/v1/users/me/machines/{lease_id}/release` Tags: `resources` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | lease_id | path | yes | string | | ## Request Body Required: yes - `application/json`: ReleaseMachineLeaseRequest ## Responses ### 200 Successful Response - `application/json`: UserMachineLeaseResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Hide All Active Updates Canonical URL: https://docs.flywheel.paradigma.inc/api/updates/hide_all_active_updates_v1_updates_hide_all_active_post Flywheel public documentation page. Method: `POST` Path: `/v1/updates/hide-all-active` Tags: `updates` ## Responses ### 200 Successful Response - `application/json`: HideAllActiveUpdatesResponse --- # Hide Update Canonical URL: https://docs.flywheel.paradigma.inc/api/updates/hide_update_v1_updates__announcement_id__hide_post Flywheel public documentation page. Method: `POST` Path: `/v1/updates/{announcement_id}/hide` Tags: `updates` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | announcement_id | path | yes | string | | ## Responses ### 200 Successful Response - `application/json`: HideUpdateResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # List Updates Canonical URL: https://docs.flywheel.paradigma.inc/api/updates/list_updates_v1_updates_get Flywheel public documentation page. Method: `GET` Path: `/v1/updates` Tags: `updates` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | page | query | no | integer default: 1 | | | page_size | query | no | integer default: 20 | | | include_hidden | query | no | boolean default: false | | | include_archived | query | no | boolean default: false | | ## Responses ### 200 Successful Response - `application/json`: ListUpdatesResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Unhide Update Canonical URL: https://docs.flywheel.paradigma.inc/api/updates/unhide_update_v1_updates__announcement_id__hide_delete Flywheel public documentation page. Method: `DELETE` Path: `/v1/updates/{announcement_id}/hide` Tags: `updates` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | announcement_id | path | yes | string | | ## Responses ### 200 Successful Response - `application/json`: HideUpdateResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Branch Node Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/branch_node_v1_nodes__node_id__branch_post Create a branch from a node. Method: `POST` Path: `/v1/nodes/{node_id}/branch` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Request Body Required: no - `application/json`: BranchNodeRequest | null ## Responses ### 200 Successful Response - `application/json`: NodeResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Bulk Delete Nodes Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/bulk_delete_nodes_v1_nodes_bulk_delete_post Delete multiple nodes and their descendants. Method: `POST` Path: `/v1/nodes/bulk-delete` Tags: `nodes` ## Request Body Required: yes - `application/json`: BulkDeleteRequest ## Responses ### 200 Successful Response - `application/json`: BulkNodeDeleteResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Bulk Get Node Access Summaries Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/bulk_get_node_access_summaries_v1_nodes_access_policy_summaries_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/access-policy/summaries` Tags: `nodes` ## Request Body Required: yes - `application/json`: BulkNodeAccessSummaryRequest ## Responses ### 200 Successful Response - `application/json`: BulkNodeAccessSummaryResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Bulk Set Node Access Policy Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/bulk_set_node_access_policy_v1_nodes_access_policy_bulk_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/access-policy/bulk` Tags: `nodes` ## Request Body Required: yes - `application/json`: BulkNodeAccessPolicyRequest ## Responses ### 200 Successful Response - `application/json`: BulkNodeAccessPolicyResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Create Node Filter Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/create_node_filter_v1_users_me_node_filters_post Flywheel public documentation page. Method: `POST` Path: `/v1/users/me/node-filters` Tags: `nodes` ## Request Body Required: yes - `application/json`: CreateNodeFilterRequest ## Responses ### 200 Successful Response - `application/json`: NodeFilterResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Create Node Tag Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/create_node_tag_v1_nodes__root_node_id__tags_post Flywheel public documentation page. Method: `POST` Path: `/v1/nodes/{root_node_id}/tags` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | root_node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: CreateNodeTagRequest ## Responses ### 200 Successful Response - `application/json`: NodeResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Create Node Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/create_node_v1_nodes_post Create a new node. Method: `POST` Path: `/v1/nodes` Tags: `nodes` ## Request Body Required: yes - `application/json`: CreateNodeRequest ## Responses ### 201 Successful Response - `application/json`: NodeResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Delete Node Filter Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/delete_node_filter_v1_users_me_node_filters__filter_id__delete Flywheel public documentation page. Method: `DELETE` Path: `/v1/users/me/node-filters/{filter_id}` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | filter_id | path | yes | string | | ## Responses ### 204 Successful Response No response body schema. ### 422 Validation Error - `application/json`: HTTPValidationError --- # Delete Node Tag Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/delete_node_tag_v1_nodes__root_node_id__tags__tag_id__delete Flywheel public documentation page. Method: `DELETE` Path: `/v1/nodes/{root_node_id}/tags/{tag_id}` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | root_node_id | path | yes | string | | | tag_id | path | yes | string | | ## Request Body Required: yes - `application/json`: DeleteNodeTagRequest ## Responses ### 200 Successful Response - `application/json`: NodeResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Delete Node Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/delete_node_v1_nodes__node_id__delete Delete a node and its descendants. Method: `DELETE` Path: `/v1/nodes/{node_id}` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | | delete_mode | query | no | string enum: "cascade", "detach_shared" default: "detach_shared" | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Export Subgraph Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/export_subgraph_v1_export_post Export selected nodes as node-only graph payload. Method: `POST` Path: `/v1/export` Tags: `nodes` ## Request Body Required: yes - `application/json`: ExportSubgraphRequest ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Export Summary Pdf Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/export_summary_pdf_v1_export_summary_pdf_post Export a PDF summary of the selected subgraph via LLM + LaTeX. Method: `POST` Path: `/v1/export-summary-pdf` Tags: `nodes` ## Request Body Required: yes - `application/json`: ExportSummaryRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Export Summary Render Pdf Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/export_summary_render_pdf_v1_export_summary_render_pdf_post Flywheel public documentation page. Method: `POST` Path: `/v1/export-summary-render-pdf` Tags: `nodes` ## Request Body Required: yes - `application/json`: RenderSummaryPdfRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Export Summary Stream Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/export_summary_stream_v1_export_summary_stream_post Flywheel public documentation page. Method: `POST` Path: `/v1/export-summary-stream` Tags: `nodes` ## Request Body Required: yes - `application/json`: ExportSummaryRequest ## Responses ### 200 Successful Response - `application/json`: value ### 422 Validation Error - `application/json`: HTTPValidationError --- # Export Summary Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/export_summary_v1_export_summary_post Export a markdown summary of the selected subgraph via LLM summarization. Method: `POST` Path: `/v1/export-summary` Tags: `nodes` ## Request Body Required: yes - `application/json`: ExportSummaryRequest ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get Graph Facets Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/get_graph_facets_v1_graph_facets_get Flywheel public documentation page. Method: `GET` Path: `/v1/graph/facets` Tags: `nodes` ## Responses ### 200 Successful Response - `application/json`: NodeFilterFacetsResponse --- # Get Graph Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/get_graph_v1_graph_get Get the graph structure starting from a node or all roots. Method: `GET` Path: `/v1/graph` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | query | no | string \| null | | | depth | query | no | integer \| null | | | max_nodes | query | no | integer \| null | | | page_size | query | no | integer \| null | | | cursor | query | no | string \| null | | | access_scopes | query | no | string \| null | | | private_only | query | no | boolean default: false | | | filter | query | no | array \| null | | | exclude | query | no | array \| null | | | projection | query | no | string enum: "full", "topology", "core" default: "topology" | | | min_graph_event_id | query | no | string \| null | | | consistency_wait_ms | query | no | integer \| null | | ## Responses ### 200 Successful Response - `application/json`: GraphResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get Node Access Policy Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/get_node_access_policy_v1_nodes__node_id__access_policy_get Flywheel public documentation page. Method: `GET` Path: `/v1/nodes/{node_id}/access-policy` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Responses ### 200 Successful Response - `application/json`: NodeAccessPolicyResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get Node Artifact Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/get_node_artifact_v1_nodes__node_id__artifacts__artifact_id__get Flywheel public documentation page. Method: `GET` Path: `/v1/nodes/{node_id}/artifacts/{artifact_id}` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | | artifact_id | path | yes | string | | ## Responses ### 200 Successful Response - `application/json`: NodeArtifactResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get Node Artifacts Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/get_node_artifacts_v1_nodes__node_id__artifacts_get Flywheel public documentation page. Method: `GET` Path: `/v1/nodes/{node_id}/artifacts` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | | offset | query | no | integer default: 0 | | | limit | query | no | integer default: 50 | | ## Responses ### 200 Successful Response - `application/json`: NodeArtifactsPageResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get Node Budgets Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/get_node_budgets_v1_nodes__node_id__budgets_get Flywheel public documentation page. Method: `GET` Path: `/v1/nodes/{node_id}/budgets` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | | budget_source | query | no | string \| null | | | status | query | no | string \| null | | | limit | query | no | integer default: 20 | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get Node Children Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/get_node_children_v1_nodes__node_id__children_get List a node's direct children with cursor pagination. Method: `GET` Path: `/v1/nodes/{node_id}/children` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | | first | query | no | integer default: 100 | | | after | query | no | string \| null | | | projection | query | no | string enum: "topology", "core" default: "topology" | | ## Responses ### 200 Successful Response - `application/json`: NodeRelationshipConnectionResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get Node Parents Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/get_node_parents_v1_nodes__node_id__parents_get List a node's direct parents with cursor pagination. Method: `GET` Path: `/v1/nodes/{node_id}/parents` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | | first | query | no | integer default: 100 | | | after | query | no | string \| null | | | projection | query | no | string enum: "topology", "core" default: "topology" | | ## Responses ### 200 Successful Response - `application/json`: NodeRelationshipConnectionResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Get Node Tree Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/get_node_tree_v1_nodes__node_id__tree_get Load a merge-aware tree/DAG projection for node overview rendering. Method: `GET` Path: `/v1/nodes/{node_id}/tree` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | | max_nodes | query | no | integer default: 5000 | | | projection | query | no | string enum: "full", "topology", "core" default: "full" | | | min_graph_event_id | query | no | string \| null | | | consistency_wait_ms | query | no | integer \| null | | ## Responses ### 200 Successful Response - `application/json`: NodeTreeResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Import Subgraph Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/import_subgraph_v1_import_post Import a previously-exported subgraph, creating fresh nodes. Method: `POST` Path: `/v1/import` Tags: `nodes` ## Request Body Required: yes - `application/json`: ImportSubgraphRequest ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # List Node Filters Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/list_node_filters_v1_users_me_node_filters_get Flywheel public documentation page. Method: `GET` Path: `/v1/users/me/node-filters` Tags: `nodes` ## Responses ### 200 Successful Response - `application/json`: NodeFiltersResponse --- # List Nodes Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/list_nodes_v1_nodes_get List all nodes with pagination, or a specific node. Method: `GET` Path: `/v1/nodes` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | query | no | string \| null | | | page | query | no | integer default: 1 | | | page_size | query | no | integer \| null | | | access_scopes | query | no | string \| null | | | private_only | query | no | boolean default: false | | | root_only | query | no | boolean default: false | | | owners | query | no | array \| null | | | writers | query | no | array \| null | | | visibility | query | no | array \| null | | | repo_url | query | no | string \| null | | | repo_match_mode | query | no | string enum: "exact", "fuzzy" default: "exact" | | | projection | query | no | string enum: "full", "core", "topology" default: "topology" | | ## Responses ### 200 Successful Response - `application/json`: PaginatedNodesResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Merge Nodes Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/merge_nodes_v1_nodes_merge_post Merge multiple nodes into a single node. Method: `POST` Path: `/v1/nodes/merge` Tags: `nodes` ## Request Body Required: yes - `application/json`: MergeNodesRequest ## Responses ### 200 Successful Response - `application/json`: NodeResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Resolve Node Slug Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/resolve_node_slug_v1_nodes_resolve_by_slug_get Flywheel public documentation page. Method: `GET` Path: `/v1/nodes/resolve-by-slug` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | slug_name | query | yes | string | | | context_node_id | query | no | string \| null | | | projection | query | no | string enum: "full", "core", "topology" default: "core" | | ## Responses ### 200 Successful Response - `application/json`: object ### 422 Validation Error - `application/json`: HTTPValidationError --- # Set Node Access Policy Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/set_node_access_policy_v1_nodes__node_id__access_policy_put Flywheel public documentation page. Method: `PUT` Path: `/v1/nodes/{node_id}/access-policy` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: NodeAccessPolicyRequest ## Responses ### 200 Successful Response - `application/json`: NodeAccessPolicyResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Set Node Tag Assignments Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/set_node_tag_assignments_v1_nodes__node_id__tags_put Flywheel public documentation page. Method: `PUT` Path: `/v1/nodes/{node_id}/tags` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | ## Request Body Required: yes - `application/json`: SetNodeTagAssignmentsRequest ## Responses ### 200 Successful Response - `application/json`: NodeResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # Update Node Tag Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/update_node_tag_v1_nodes__root_node_id__tags__tag_id__patch Flywheel public documentation page. Method: `PATCH` Path: `/v1/nodes/{root_node_id}/tags/{tag_id}` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | root_node_id | path | yes | string | | | tag_id | path | yes | string | | ## Request Body Required: yes - `application/json`: UpdateNodeTagRequest ## Responses ### 200 Successful Response - `application/json`: NodeResponse ### 422 Validation Error - `application/json`: HTTPValidationError --- # View Node Canonical URL: https://docs.flywheel.paradigma.inc/api/nodes/view_node_v1_nodes__node_id__get View a specific node by ID. Method: `GET` Path: `/v1/nodes/{node_id}` Tags: `nodes` ## Parameters | Name | Location | Required | Type | Description | | --- | --- | --- | --- | --- | | node_id | path | yes | string | | | projection | query | no | string enum: "full", "core", "topology" default: "core" | | | artifacts_limit | query | no | integer \| null | | ## Responses ### 200 Successful Response - `application/json`: NodeResponse | null ### 422 Validation Error - `application/json`: HTTPValidationError