docs(readme): align command listing with reality#20
Merged
govindkavaturi-art merged 1 commit intomainfrom Apr 20, 2026
Merged
Conversation
Three corrections to README.md after auditing the command surface:
1. Remove all references to nonexistent `cueapi executions` command:
- AI-agent header: "Check executions: cueapi executions" →
"View a cue and its recent executions: cueapi get <cue-id>"
- Quick start example: replace `cueapi executions` with
`cueapi get <cue-id>`. Executions are surfaced inside cue detail
(cli.py:261-266 prints "Recent executions" after the cue body).
- Commands table row: drop the row entirely.
2. Add `cueapi update <id>` row — command was added in v0.1.3 but
never made it into the README table.
3. Add `cueapi manage` row — opens the Stripe billing portal
(separate from `cueapi upgrade` which opens checkout).
4. Annotate `cueapi create` with the `--worker`, `--payload`, and
`--on-failure` flags (also v0.1.3 additions). Full reference will
land alongside the docs-site CLI page update.
Net: -1 stale row, +2 missing rows, 4 entries clarified. Zero code
changes.
govindkavaturi-art
deleted the
docs/cli-update-command-and-fix-stale-refs
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three corrections to README.md after auditing the command surface against `cueapi/cli.py`:
1. Remove stale `cueapi executions` references
The README referenced a `cueapi executions` command that doesn't exist in the CLI. Three places fixed:
Reality: executions are surfaced inside cue detail. `cli.py:261-266` prints "Recent executions" after the cue body when running `cueapi get`.
2. Add missing rows
3. Annotate flags
`cueapi create` row now mentions `--worker`, `--payload`, `--on-failure` flags (also v0.1.3 additions). Full reference will land alongside the docs-site CLI page update.
Diff size
-1 stale row, +2 missing rows, 4 entries clarified. Zero code changes.
Test plan