Repository navigation
docs(cli): document build list, build download and baseline download - #266
Merged
Merged
Conversation
…load` Add the three commands to the CLI reference: listing a project's builds, downloading a build's screenshots, and downloading the project's latest baseline, with the project-token-only rule, the file layout and the JSON output. Point the data export section of the security page to them instead of the jq and curl script. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
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.
Documents the three commands added to
@argos-ci/cliin argos-ci/argos-javascript#405 (ARG-522: export a project's screenshots and baselines).Merge this once the CLI release that ships them is out. They land in the next minor after 6.10.0, which should be 6.11.0 (Lerna + conventional commits). That version is an assumption: it isn't released yet. The docs don't add version notes for CLI features, so this PR doesn't either.
What's documented
CLI reference (
docs/sdks-reference/argos-command-line-interface-cli.md), written as prose plus examples like the other commands on the page, since the page leaves full flag lists to--help:build list,build download <buildReference>,baseline download.build listandbuild downloadwork with a project token.baseline downloadonly accepts a project token and reads that token's own project, so it has no--projectand rejects personal access tokens, including theargos loginone.build list, with--branch,--commit(full 40-character SHA only),--search(build name, branch substring, commit prefix), and--project/ARGOS_PROJECTfor personal access tokens.build downloaddefaults to./argos-build-<number>, fails while the build is processing, and skips removed snapshots.baseline downloadpicks the newest build on the default baseline branch that is eligible as a baseline, linking to the baseline page's eligibility rules (it uses the same criteria as the "Eligible as baseline" chip). It covers--branch,--build-name(defaultdefault, one name at a time),--mode, the omitted failure screenshots, the 1,000-build search window and the "No baseline found" error.argos uploadstores as PNG under their.jpgname), colliding names get a(2)suffix, and the--jsonshape{ build, directory, files: [{ name, url, contentType, status, path }] }.build list(--limit, 100 by default).Security and compliance › Export your data: the feature came from the question "can I bulk export all screenshots and baselines of a project?". This section answered it with a jq + curl script over
build snapshots --json. I replaced the script with a short pointer to the three commands.🤖 Generated with Claude Code