📝 Document Scan Analyze, Delete, and Fix the View Verb Name#88
Open
gilday wants to merge 2 commits into
Open
Conversation
The pixee CLI 0.13.0 release added `pixee scan analyze <id>` and `pixee scan delete <id>` and surfaces a single-scan view as a positional argument on the top-level subcommand (`pixee scan <scan-id>`) rather than a `get` verb. The pixee-scan skill on `origin/main` documented `list` plus a non-existent `## pixee scan get` section — so the audit-skills workflow caught both missing verbs and a doc bug that would have an agent type a command the binary rejects with "unknown command". This corrects the existing section and adds the two new ones. `## pixee scan get` is replaced with `## pixee scan <scan-id>`, explicitly calling out that the view-by-id form is the positional argument on the top-level command — no `get` subcommand exists. `## pixee scan analyze` documents the new subcommand, including `--finding` for scoping to specific findings, `--watch` for chaining the start call into the same poll-and-narrate behavior provided by `pixee analysis view --watch`, `--interval` cadence, the `Started analysis <id> on scan <id>` stdout contract, and the 422 non-analyzable error path. `## pixee scan delete` matches the destructive-verb voice already in `pixee-workflow` and `pixee-repo`: UUID positional, no flags, no client-side confirmation prompt. The cross-reference to `pixee-analysis` is added to the PREREQUISITES blockquote so agents can follow the start-then-watch handoff. Four new runnable examples cover the bread-and-butter calls — `analyze --watch` on the whole scan, scoped `--finding` re-analysis with a longer `--interval`, the capture-the-id-and-watch-separately pattern, and `scan delete` — and the existing JSON view examples are corrected to use the positional form. Two best-practices bullets capture `analyze --watch` versus hand-rolled polling and when to scope with `--finding`. The picker description is rewritten to verb-first "List, view, analyze, and delete Pixee scans with filters for repository, branch, detector tool, and analysis state." (115 chars, picker-safe). The README bullet is refreshed to match. /close ISS-7254
The pixee CLI 0.15.0 release replaced the positional view-by-id form (`pixee scan <scan-id>`) with an explicit `pixee scan view <scan-id>` subcommand. The audit-skills follow-up on this skill was drafted against 0.13.0 where the positional shortcut still existed and called out its quirk explicitly; this brings the section in line with the 0.15.0 reality. The `## pixee scan <scan-id>` H2 is renamed to `## pixee scan view`, and the body drops the "positional argument on the top-level command" framing in favor of describing a normal subcommand. The text-mode output description is updated to the new sectioned `Key: value` block (`Id`, `Detector`, `Branch`, `Sha`, `Imported at`, `Expires at` — colon-separated, one field per line) instead of the prior tab-separated row; `Branch` is omitted for branch-less detectors. JSON output is unchanged. Examples that used `pixee scan <id> --json` (the fetch-one-scan example and the HAL walk) become `pixee scan view <id> --json`, and the two best-practices bullets that referenced the positional form are rewritten to use `view` as well. The picker description doesn't change — "view" was already in the verb list. The README bullet collapses `pixee scan <id> (view)` to just `view` to match. /close ISS-7254
gilday
force-pushed
the
worktree-iss-7254+fix-pixee-scan-skill
branch
from
7f90aaa to
c588711
Compare
|
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.
The pixee CLI 0.13.0 release added
pixee scan analyze <id>andpixee scan delete <id>alongside the existinglist, and 0.15.0 (ISS-7255) replaced the positionalpixee scan <scan-id>view-by-id form with an explicitpixee scan view <scan-id>subcommand. The audit-skills workflow caught two skill problems: the publishedpixee-scanskill called the view verbpixee scan get(which the binary rejects with "unknown command"), and it documented neitheranalyzenordelete.This PR brings the skill in line with the 0.15.0 binary. The
## pixee scan getheading is replaced with## pixee scan view, the body describes a normal subcommand (no more "positional shortcut" framing), and the text-mode output description matches the new sectionedKey: valueblock (Id,Detector,Branch,Sha,Imported at,Expires at) instead of the prior tab-separated row.## pixee scan analyzedocuments the new subcommand, including--findingfor scoping the analysis to specific findings,--watchfor chaining the start call into the same poll-and-narrate behavior provided bypixee analysis view --watch, the--intervalcadence default, theStarted analysis <id> on scan <id>stdout contract, and the 422 non-analyzable error path.## pixee scan deletematches the destructive-verb voice already used inpixee-workflowandpixee-repo: UUID positional, no flags, no client-side confirmation prompt.The cross-reference to
pixee-analysisis added to the PREREQUISITES blockquote so agents can follow the start-then-watch handoff. Four new runnable examples cover the bread-and-butter calls —analyze --watchon a whole scan, scoped--findingre-analysis with a longer--interval, the capture-the-id-and-watch-separately pattern, andscan delete— and the existing JSON view examples now usepixee scan view <id>. Two best-practices bullets captureanalyze --watchversus hand-rolled polling and when to scope with--finding.The picker description is rewritten verb-first to "List, view, analyze, and delete Pixee scans with filters for repository, branch, detector tool, and analysis state." (115 chars, no picker-breaking punctuation). The README bullet is refreshed to match.
/close ISS-7254