compute-grants:list
List your compute grants: spending allowances, each tied to one approval session. Returns `grants`, each with `compute_grant_id`, `approval_session_id`, `budget_source`, `compute_budget_id`, `grant_cents`, `spent_cents`, `remaining_cents`, `status` (`active` or `expired`) and timestamps. A session ID that is unknown or not yours returns an empty list.
Reference for flywheel compute-grants:list.
Command Group
Other Commands
Summary
List your compute grants: spending allowances, each tied to one approval session. Returns grants, each with compute_grant_id, approval_session_id, budget_source, compute_budget_id, grant_cents, spent_cents, remaining_cents, status (active or expired) and timestamps. A session ID that is unknown or not yours returns an empty list.
Effect
read-only
Usage
flywheel compute-grants:list [FLAGS]Required flags
None.
Optional flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--budget_source | string | user (your own credits) or root (a campaign budget its organizer funded). Omitted: both. | ||
--status | string | active or expired. Omitted: both. | ||
--approval_session_id | string | session_id from compute-grants:request-approval or approval-sessions:list. A grant bound to another session: 403. | ||
--limit | integer | Most items to return (omitted: command default). No next page: raise limit or narrow filters. | ||
--format | FORMAT | json, tsv, csv, table | Output format for command results. | |
--env | PROFILE | Select a CLI profile; unconfigured default requires FLYWHEEL_BASE_URL. | ||
--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 | Confirm forced compute:release-all --force. Other runtime commands do not read --yes. | |||
--debug | Print structured request debugging with secrets masked. | |||
--verbose | Print verbose progress for long-running operations. | |||
-h, --help | Show this help. |
Examples
List grants.
flywheel compute-grants:list --budget_source user --status activeOutput
Default format: json.
| Field | Type |
|---|---|
grants | array<object> |
api-keys:rotate
Rotate an API key (refuses to rotate the active one unless --allow-self).
compute-grants:request-approval
Ask for compute spending to be approved before you acquire. Returns one of three outcomes in `status`. `already_approved`: an active grant of this session with money left covers it; pass its `compute_grant_id` to compute:acquire. `approval_required`: a person must open and approve `approval_url` (it proposes `suggested_hard_cap_cents`), then call compute-grants:list with the same --approval_session_id until the grant is `active`. `insufficient_credits`: your credit balance is zero or below, so no grant funded from your own credits can be created; add credits (see credits:balance) and ask again. Every outcome also carries `budget_source`, `grant_action` and `approval_session_id`. It records the request and refreshes the session; it launches and spends nothing.