Utilities
CLI utilities: update, send-debug, release-notes, ci upload.
| Command | Use |
|---|---|
update | Install the latest stable CLI. |
send-debug | Upload a debug bundle for support. |
release-notes | Print release notes. |
ci upload | Upload a PR-trigger artifact from CI. |
update
Download and install the latest stable release (the same way the install
script does) and switch ax over to it on the next run.
ax update [--print]| Argument / flag | What it does |
|---|---|
--print | Print the install command instead of running it. |
send-debug
Bundle a run, its source experiment, and host metadata into a tar.gz and upload it to the platform for debugging. Bundles include agent and test logs verbatim; the command warns before uploading because anything those logs echoed (including secrets) is in the bundle.
ax send-debug [RUN_ID]| Argument / flag | What it does |
|---|---|
[RUN_ID] | Run id. Omit to use the most recent completed local group. |
--note <text> | Free-form note recorded with the bundle. |
--out <path> | Also write the tar.gz locally (useful with --dry-run). |
--no-workspace | Exclude variants/*/workspace/ (can be hundreds of MiB). |
--no-fs-diff | Exclude variants/*/fs-diff/. |
--dry-run | Build the bundle and print stats without uploading. |
--yes | Skip the secret-leak confirmation prompt. |
release-notes
Print release notes as Markdown.
ax release-notes [VERSION]| Argument / flag | What it does |
|---|---|
[VERSION] | Release version to show. Defaults to the latest. |
--raw | Print the fetched Markdown without metadata banners. |
--source-url | Print only the resolved source URL. |
ci upload
Upload a CI-built artifact for one source-less files: slot, keyed to the
commit, so the !ax run PR trigger can stage it. Runs in your CI workflow,
authenticated by an org API key (AX_API_KEY). See GitHub CI
for workflow setup, repo linking, and slot naming.
ax ci upload <SLOT> <PATH>| Argument / flag | What it does |
|---|---|
<SLOT> | Required. Source-less files: slot handle the experiment declares. |
<PATH> | Required. Host file or directory to upload. |
--repo <owner/repo> | Repo the artifact belongs to. Defaults to $GITHUB_REPOSITORY. |
--commit <sha> | Commit the artifact was built from. Defaults to $GITHUB_SHA. |
--org <org-id> | Use this org without changing the active CLI org. |