avr-cli 0.7.0__py3-none-win_amd64.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- avr_cli-0.7.0.data/data/share/avr/LICENSE +201 -0
- avr_cli-0.7.0.data/data/share/avr/README.md +461 -0
- avr_cli-0.7.0.data/data/share/avr/SECURITY.md +58 -0
- avr_cli-0.7.0.data/data/share/avr/THIRD-PARTY-NOTICES.txt +1541 -0
- avr_cli-0.7.0.data/data/share/avr/completions/_avr +25 -0
- avr_cli-0.7.0.data/data/share/avr/completions/avr.bash +38 -0
- avr_cli-0.7.0.data/data/share/avr/completions/avr.fish +17 -0
- avr_cli-0.7.0.data/data/share/avr/docs/INSTALL.md +115 -0
- avr_cli-0.7.0.data/data/share/avr/docs/REFERENCE.md +3632 -0
- avr_cli-0.7.0.data/data/share/avr/docs/reference.json +14874 -0
- avr_cli-0.7.0.data/data/share/avr/install-method +1 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-artifact-delete.1 +35 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-artifact-download.1 +35 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-artifact-get.1 +32 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-artifact-list.1 +38 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-artifact.1 +48 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-audit-events-list.1 +50 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-audit-events.1 +36 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-auth-device-login.1 +21 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-auth-login.1 +23 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-auth-logout.1 +16 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-auth-status.1 +26 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-auth-switch.1 +27 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-auth.1 +52 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-billing-invoices-download.1 +25 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-billing-invoices-list.1 +37 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-billing-invoices-show.1 +35 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-billing-invoices.1 +29 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-billing-payment-methods-add.1 +32 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-billing-payment-methods-list.1 +32 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-billing-payment-methods-remove.1 +26 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-billing-payment-methods-set-default.1 +23 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-billing-payment-methods.1 +33 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-billing-settings.1 +33 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-billing-summary.1 +32 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-billing-update-settings.1 +48 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-billing.1 +52 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-cache-delete.1 +45 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-cache-list.1 +69 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-cache-usage.1 +41 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-cache.1 +44 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-config-get.1 +25 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-config-list.1 +15 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-config-set.1 +36 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-config-unset.1 +32 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-config.1 +48 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-firewall-add.1 +47 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-firewall-delete.1 +29 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-firewall-flow-summaries.1 +47 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-firewall-list.1 +28 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-firewall-move.1 +32 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-firewall-set-default.1 +28 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-firewall-show.1 +28 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-firewall.1 +60 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-health.1 +46 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-job-list.1 +77 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-job-logs.1 +52 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-job-metrics.1 +48 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-job-ssh.1 +28 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-job-view.1 +61 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-job-watch.1 +33 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-job.1 +56 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-log-search.1 +59 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-log.1 +36 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-create.1 +34 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-email-domain-claim.1 +46 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-email-domain-list.1 +32 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-email-domain-set.1 +35 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-email-domain-verify.1 +46 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-email-domain.1 +34 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-install-add.1 +85 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-install-list.1 +32 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-install-remove.1 +41 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-install-rotate.1 +48 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-install-runner-create.1 +45 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-install-runner-delete.1 +43 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-install-runner-list.1 +34 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-install-runner-set.1 +45 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-install-runner.1 +34 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-install-set-selection.1 +49 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-install.1 +42 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-list.1 +39 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-members.1 +42 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-saml-configure.1 +73 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-saml-enforcement.1 +40 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-saml-remove.1 +25 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-saml-show.1 +36 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-saml-sp-metadata.1 +30 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-saml-test.1 +33 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org-saml.1 +42 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-org.1 +56 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-pr-list.1 +57 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-pr.1 +36 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-repo-clone.1 +44 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-repo-list.1 +43 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-repo-mirror-create.1 +57 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-repo-mirror-disable.1 +53 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-repo-mirror-enable.1 +50 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-repo-mirror-locations.1 +44 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-repo-mirror-place.1 +54 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-repo-mirror-status.1 +49 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-repo-mirror-unplace.1 +57 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-repo-mirror.1 +44 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-repo-public-mirror-cancel.1 +52 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-repo-public-mirror-check.1 +51 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-repo-public-mirror-request.1 +53 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-repo-public-mirror-requests.1 +44 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-repo-public-mirror-view.1 +47 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-repo-public-mirror.1 +36 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-repo.1 +48 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-run-cancel.1 +38 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-run-diagnose.1 +40 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-run-list.1 +86 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-run-logs.1 +55 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-run-rerun.1 +51 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-run-view.1 +83 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-run-watch.1 +58 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-run.1 +60 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-sbom-download.1 +45 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-sbom-generate.1 +62 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-sbom-list.1 +52 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-sbom-view.1 +59 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-sbom.1 +48 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-settings-list.1 +53 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-settings-reset.1 +35 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-settings-schema.1 +44 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-settings-set.1 +40 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-settings.1 +48 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-status.1 +44 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-tests-list.1 +55 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-tests.1 +37 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-token-create.1 +63 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-token-list.1 +46 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-token-revoke.1 +35 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-token-view.1 +47 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-token.1 +49 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-bootstrap.1 +87 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-capabilities.1 +36 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-create.1 +108 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-delete.1 +50 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-fork.1 +53 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-list.1 +51 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-metrics.1 +52 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-pause.1 +50 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-port-forward.1 +57 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-rdp.1 +50 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-resume.1 +50 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-rotate-https-label.1 +41 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-show.1 +40 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-ssh-config.1 +61 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-ssh.1 +63 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-update.1 +62 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-usage.1 +43 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm-vnc.1 +50 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-vm.1 +104 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-workflow-list.1 +52 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-workflow-run.1 +60 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-workflow-view.1 +59 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr-workflow.1 +44 -0
- avr_cli-0.7.0.data/data/share/avr/man/man1/avr.1 +108 -0
- avr_cli-0.7.0.data/data/share/avr/manifest.json +172 -0
- avr_cli-0.7.0.data/scripts/avr-cli.exe +0 -0
- avr_cli-0.7.0.data/scripts/avr.exe +0 -0
- avr_cli-0.7.0.dist-info/METADATA +13 -0
- avr_cli-0.7.0.dist-info/RECORD +168 -0
- avr_cli-0.7.0.dist-info/WHEEL +4 -0
- avr_cli-0.7.0.dist-info/licenses/LICENSE +201 -0
- avr_cli-0.7.0.dist-info/licenses/THIRD-PARTY-NOTICES.txt +1541 -0
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
.TH AVR\-REPO\-PUBLIC\-MIRROR 1 "" "avr 0.7.0" "Avrea CLI"
|
|
2
|
+
.SH NAME
|
|
3
|
+
avr-repo-public-mirror \- Request and browse mirrors of public GitHub repositories.
|
|
4
|
+
.SH SYNOPSIS
|
|
5
|
+
.B avr repo public-mirror
|
|
6
|
+
[OPTIONS] COMMAND [ARGS]...
|
|
7
|
+
.SH DESCRIPTION
|
|
8
|
+
Request and browse mirrors of public GitHub repositories.
|
|
9
|
+
.PP
|
|
10
|
+
.SH COMMANDS
|
|
11
|
+
.TP
|
|
12
|
+
cancel
|
|
13
|
+
Cancel one pending public-mirror request.
|
|
14
|
+
.TP
|
|
15
|
+
check
|
|
16
|
+
Check whether a public GitHub repository mirror is available.
|
|
17
|
+
.TP
|
|
18
|
+
request
|
|
19
|
+
Request a mirror of a public GitHub repository.
|
|
20
|
+
.TP
|
|
21
|
+
requests
|
|
22
|
+
List your organization's public-mirror requests.
|
|
23
|
+
.TP
|
|
24
|
+
view
|
|
25
|
+
View one public-mirror request.
|
|
26
|
+
.SH SEE ALSO
|
|
27
|
+
.BR avr (1),
|
|
28
|
+
.BR avr-repo (1),
|
|
29
|
+
.BR avr-repo-clone (1),
|
|
30
|
+
.BR avr-repo-list (1),
|
|
31
|
+
.BR avr-repo-mirror (1),
|
|
32
|
+
.BR avr-repo-public-mirror-cancel (1),
|
|
33
|
+
.BR avr-repo-public-mirror-check (1),
|
|
34
|
+
.BR avr-repo-public-mirror-request (1),
|
|
35
|
+
.BR avr-repo-public-mirror-requests (1),
|
|
36
|
+
.BR avr-repo-public-mirror-view (1)
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
.TH AVR\-REPO 1 "" "avr 0.7.0" "Avrea CLI"
|
|
2
|
+
.SH NAME
|
|
3
|
+
avr-repo \- Manage repositories, git mirrors, and public mirrors.
|
|
4
|
+
.SH SYNOPSIS
|
|
5
|
+
.B avr repo
|
|
6
|
+
[OPTIONS] COMMAND [ARGS]...
|
|
7
|
+
.SH DESCRIPTION
|
|
8
|
+
Manage repositories, git mirrors, and public mirrors.
|
|
9
|
+
.PP
|
|
10
|
+
.SH COMMANDS
|
|
11
|
+
.TP
|
|
12
|
+
clone
|
|
13
|
+
Clone a repository from its nearest available Avrea mirror.
|
|
14
|
+
.TP
|
|
15
|
+
list
|
|
16
|
+
List repositories you can access in an organization.
|
|
17
|
+
.TP
|
|
18
|
+
mirror
|
|
19
|
+
Manage this repository's avrea-git mirror (feature-flagged).
|
|
20
|
+
.TP
|
|
21
|
+
public-mirror
|
|
22
|
+
Request and browse mirrors of public GitHub repositories.
|
|
23
|
+
.SH SEE ALSO
|
|
24
|
+
.BR avr (1),
|
|
25
|
+
.BR avr-artifact (1),
|
|
26
|
+
.BR avr-status (1),
|
|
27
|
+
.BR avr-run (1),
|
|
28
|
+
.BR avr-pr (1),
|
|
29
|
+
.BR avr-job (1),
|
|
30
|
+
.BR avr-vm (1),
|
|
31
|
+
.BR avr-workflow (1),
|
|
32
|
+
.BR avr-cache (1),
|
|
33
|
+
.BR avr-tests (1),
|
|
34
|
+
.BR avr-sbom (1),
|
|
35
|
+
.BR avr-log (1),
|
|
36
|
+
.BR avr-auth (1),
|
|
37
|
+
.BR avr-token (1),
|
|
38
|
+
.BR avr-config (1),
|
|
39
|
+
.BR avr-settings (1),
|
|
40
|
+
.BR avr-firewall (1),
|
|
41
|
+
.BR avr-billing (1),
|
|
42
|
+
.BR avr-audit-events (1),
|
|
43
|
+
.BR avr-org (1),
|
|
44
|
+
.BR avr-health (1),
|
|
45
|
+
.BR avr-repo-clone (1),
|
|
46
|
+
.BR avr-repo-list (1),
|
|
47
|
+
.BR avr-repo-mirror (1),
|
|
48
|
+
.BR avr-repo-public-mirror (1)
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
.TH AVR\-RUN\-CANCEL 1 "" "avr 0.7.0" "Avrea CLI"
|
|
2
|
+
.SH NAME
|
|
3
|
+
avr-run-cancel \- Cancel an in-progress or queued workflow run.
|
|
4
|
+
.SH SYNOPSIS
|
|
5
|
+
.B avr run cancel
|
|
6
|
+
[OPTIONS] RUN
|
|
7
|
+
.SH DESCRIPTION
|
|
8
|
+
Cancel an in-progress or queued workflow run.
|
|
9
|
+
.PP
|
|
10
|
+
RUN accepts the same Avrea IDs, GitHub run IDs, and run URLs as `avr run view`.
|
|
11
|
+
.PP
|
|
12
|
+
.RS 4
|
|
13
|
+
.nf
|
|
14
|
+
Examples:
|
|
15
|
+
avr run cancel run-019e5a2e474e71c297e452279d4bcdea
|
|
16
|
+
avr run cancel run-019e5a2e474e71c297e452279d4bcdea --yes
|
|
17
|
+
.fi
|
|
18
|
+
.RE
|
|
19
|
+
.SH ARGUMENTS
|
|
20
|
+
.TP
|
|
21
|
+
\fIRUN\fR
|
|
22
|
+
\&
|
|
23
|
+
.SH OPTIONS
|
|
24
|
+
.TP
|
|
25
|
+
\fB\-\-org\fR \fITEXT\fR
|
|
26
|
+
Organization ID or slug.
|
|
27
|
+
.TP
|
|
28
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
29
|
+
Skip the confirmation prompt.
|
|
30
|
+
.SH SEE ALSO
|
|
31
|
+
.BR avr (1),
|
|
32
|
+
.BR avr-run (1),
|
|
33
|
+
.BR avr-run-diagnose (1),
|
|
34
|
+
.BR avr-run-list (1),
|
|
35
|
+
.BR avr-run-logs (1),
|
|
36
|
+
.BR avr-run-rerun (1),
|
|
37
|
+
.BR avr-run-view (1),
|
|
38
|
+
.BR avr-run-watch (1)
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
.TH AVR\-RUN\-DIAGNOSE 1 "" "avr 0.7.0" "Avrea CLI"
|
|
2
|
+
.SH NAME
|
|
3
|
+
avr-run-diagnose \- Explain a failed or unexpectedly slow workflow run.
|
|
4
|
+
.SH SYNOPSIS
|
|
5
|
+
.B avr run diagnose
|
|
6
|
+
[OPTIONS] RUN
|
|
7
|
+
.SH DESCRIPTION
|
|
8
|
+
Explain a failed or unexpectedly slow workflow run.
|
|
9
|
+
.PP
|
|
10
|
+
RUN accepts the same Avrea IDs, GitHub run IDs, and run URLs as `avr run view`. A job URL selects that job's attempt; the report still covers the whole attempt. The report combines jobs and failed steps, bounded failed-job log tails, queue/execution timings, runner metrics, and a prior-success workflow baseline.
|
|
11
|
+
.PP
|
|
12
|
+
.RS 4
|
|
13
|
+
.nf
|
|
14
|
+
Examples:
|
|
15
|
+
avr run diagnose run-019e5a2e474e71c297e452279d4bcdea
|
|
16
|
+
avr run diagnose 123456789 --json
|
|
17
|
+
avr run diagnose https://github.com/acme/widgets/actions/runs/123456789
|
|
18
|
+
avr run diagnose https://github.com/acme/widgets/actions/runs/123456789/job/987654321
|
|
19
|
+
.fi
|
|
20
|
+
.RE
|
|
21
|
+
.SH ARGUMENTS
|
|
22
|
+
.TP
|
|
23
|
+
\fIRUN\fR
|
|
24
|
+
\&
|
|
25
|
+
.SH OPTIONS
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-org\fR \fITEXT\fR
|
|
28
|
+
Organization ID or slug.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-json\fR
|
|
31
|
+
Output the diagnostic report as JSON.
|
|
32
|
+
.SH SEE ALSO
|
|
33
|
+
.BR avr (1),
|
|
34
|
+
.BR avr-run (1),
|
|
35
|
+
.BR avr-run-cancel (1),
|
|
36
|
+
.BR avr-run-list (1),
|
|
37
|
+
.BR avr-run-logs (1),
|
|
38
|
+
.BR avr-run-rerun (1),
|
|
39
|
+
.BR avr-run-view (1),
|
|
40
|
+
.BR avr-run-watch (1)
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
.TH AVR\-RUN\-LIST 1 "" "avr 0.7.0" "Avrea CLI"
|
|
2
|
+
.SH NAME
|
|
3
|
+
avr-run-list \- List workflow runs for an organization.
|
|
4
|
+
.SH SYNOPSIS
|
|
5
|
+
.B avr run list
|
|
6
|
+
[OPTIONS]
|
|
7
|
+
.SH DESCRIPTION
|
|
8
|
+
List workflow runs for an organization.
|
|
9
|
+
.PP
|
|
10
|
+
.RS 4
|
|
11
|
+
.nf
|
|
12
|
+
Examples:
|
|
13
|
+
avr run list
|
|
14
|
+
avr run list --status failure --limit 5
|
|
15
|
+
avr run list --status in_progress --json status,conclusion,head_branch
|
|
16
|
+
avr run list --branch main --status completed
|
|
17
|
+
avr run list --since 24h
|
|
18
|
+
avr run list --json '?' # list available fields
|
|
19
|
+
avr run list --json '*' # all fields
|
|
20
|
+
avr run list --json status,conclusion -q '[.[] | select(.status == "completed")]'
|
|
21
|
+
.fi
|
|
22
|
+
.RE
|
|
23
|
+
.PP
|
|
24
|
+
.RS 4
|
|
25
|
+
.nf
|
|
26
|
+
JSON FIELDS
|
|
27
|
+
ci_provider, workflow_name, workflow_path, conclusion, created_at, display_title, duration_seconds, event,
|
|
28
|
+
head_branch, head_sha, platform_run_id, repository, run_attempt, run_id,
|
|
29
|
+
run_number, status, triggering_actor, updated_at, workflow, workflow_id
|
|
30
|
+
.fi
|
|
31
|
+
.RE
|
|
32
|
+
.SH OPTIONS
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-\-org\fR \fITEXT\fR
|
|
35
|
+
Organization ID or slug. Uses default org if not specified (see: avr config set org).
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-repo\fR \fITEXT\fR
|
|
38
|
+
Filter by repository (org/repo or rep-xxx). Pass --repo more than once to filter multiple repositories. Auto-detected from git remote if omitted. (repeatable)
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-status\fR \fICHOICE\fR
|
|
41
|
+
Filter by state (queued, in_progress, completed) or conclusion (success, failure, ...). Repeatable. (choices: action_required, cancelled, completed, failure, in_progress, neutral, queued, skipped, stale, startup_failure, success, timed_out; repeatable)
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-branch\fR \fITEXT\fR
|
|
44
|
+
Filter by head branch (repeatable). (repeatable)
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-ci\-provider\fR \fICHOICE\fR
|
|
47
|
+
Filter by CI engine. (choices: github_actions, gitlab_ci, avrea_ci)
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-w\fR, \fB\-\-workflow\fR \fITEXT\fR
|
|
50
|
+
Filter by workflow ID (wfl- or awf-, repeatable). (repeatable)
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-since\fR \fITEXT\fR
|
|
53
|
+
Relative time window: '7d', '24h', etc. Sugar for --created-after.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-from\fR, \fB\-\-created\-after\fR \fITEXT\fR
|
|
56
|
+
Only runs created after this ISO timestamp.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-to\fR, \fB\-\-created\-before\fR \fITEXT\fR
|
|
59
|
+
Only runs created before this ISO timestamp.
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-L\fR, \fB\-\-limit\fR \fIINTEGER RANGE\fR
|
|
62
|
+
Max runs to return. (default: 20)
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-\-cursor\fR \fITEXT\fR
|
|
65
|
+
Pagination cursor from a previous response.
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-\-order\fR \fICHOICE\fR
|
|
68
|
+
Sort order. (choices: created_at.desc, created_at.asc; default: created_at.desc)
|
|
69
|
+
.TP
|
|
70
|
+
\fB\-\-json\fR \fITEXT\fR
|
|
71
|
+
Output JSON. Pass comma-separated field names, "*" for all fields, or "?" to list available fields.
|
|
72
|
+
.TP
|
|
73
|
+
\fB\-q\fR, \fB\-\-jq\fR \fITEXT\fR
|
|
74
|
+
Filter --json output through a jq expression.
|
|
75
|
+
.TP
|
|
76
|
+
\fB\-\-web\fR
|
|
77
|
+
Open in browser.
|
|
78
|
+
.SH SEE ALSO
|
|
79
|
+
.BR avr (1),
|
|
80
|
+
.BR avr-run (1),
|
|
81
|
+
.BR avr-run-cancel (1),
|
|
82
|
+
.BR avr-run-diagnose (1),
|
|
83
|
+
.BR avr-run-logs (1),
|
|
84
|
+
.BR avr-run-rerun (1),
|
|
85
|
+
.BR avr-run-view (1),
|
|
86
|
+
.BR avr-run-watch (1)
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
.TH AVR\-RUN\-LOGS 1 "" "avr 0.7.0" "Avrea CLI"
|
|
2
|
+
.SH NAME
|
|
3
|
+
avr-run-logs \- Fetch logs for a workflow run's jobs.
|
|
4
|
+
.SH SYNOPSIS
|
|
5
|
+
.B avr run logs
|
|
6
|
+
[OPTIONS] RUN
|
|
7
|
+
.SH DESCRIPTION
|
|
8
|
+
Fetch logs for a workflow run's jobs.
|
|
9
|
+
.PP
|
|
10
|
+
RUN accepts the same Avrea IDs, GitHub run IDs, and run URLs as `avr run view`. A GitHub job URL shows only that job's logs.
|
|
11
|
+
.PP
|
|
12
|
+
Long-form alternative to `avr run view --log[-failed]`. Use --follow to tail logs in real time for an in-progress job; pass --job to scope to a specific job when a run has many.
|
|
13
|
+
.PP
|
|
14
|
+
.RS 4
|
|
15
|
+
.nf
|
|
16
|
+
Examples:
|
|
17
|
+
avr run logs run-019e5a2e474e71c297e452279d4bcdea
|
|
18
|
+
avr run logs run-019e5a2e474e71c297e452279d4bcdea --failed
|
|
19
|
+
avr run logs run-019e5a2e474e71c297e452279d4bcdea --job test
|
|
20
|
+
avr run logs run-019e5a2e474e71c297e452279d4bcdea --follow
|
|
21
|
+
avr run logs https://github.com/acme/widgets/actions/runs/123456789/job/987654321
|
|
22
|
+
.fi
|
|
23
|
+
.RE
|
|
24
|
+
.SH ARGUMENTS
|
|
25
|
+
.TP
|
|
26
|
+
\fIRUN\fR
|
|
27
|
+
\&
|
|
28
|
+
.SH OPTIONS
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-org\fR \fITEXT\fR
|
|
31
|
+
Organization ID or slug.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-job\fR \fITEXT\fR
|
|
34
|
+
Restrict to GitHub jobs whose name contains this string.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-f\fR, \fB\-\-follow\fR
|
|
37
|
+
Tail logs as they appear (running jobs only).
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-failed\fR
|
|
40
|
+
Show only logs from failed jobs.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-all\-levels\fR
|
|
43
|
+
Include diagnostic-level lines (off by default).
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-no\-pager\fR
|
|
46
|
+
Print directly to stdout instead of paging through `less`. Same as setting AVR_PAGER=''.
|
|
47
|
+
.SH SEE ALSO
|
|
48
|
+
.BR avr (1),
|
|
49
|
+
.BR avr-run (1),
|
|
50
|
+
.BR avr-run-cancel (1),
|
|
51
|
+
.BR avr-run-diagnose (1),
|
|
52
|
+
.BR avr-run-list (1),
|
|
53
|
+
.BR avr-run-rerun (1),
|
|
54
|
+
.BR avr-run-view (1),
|
|
55
|
+
.BR avr-run-watch (1)
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
.TH AVR\-RUN\-RERUN 1 "" "avr 0.7.0" "Avrea CLI"
|
|
2
|
+
.SH NAME
|
|
3
|
+
avr-run-rerun \- Re-run a completed workflow run.
|
|
4
|
+
.SH SYNOPSIS
|
|
5
|
+
.B avr run rerun
|
|
6
|
+
[OPTIONS] RUN
|
|
7
|
+
.SH DESCRIPTION
|
|
8
|
+
Re-run a completed workflow run.
|
|
9
|
+
.PP
|
|
10
|
+
RUN accepts the same Avrea IDs, GitHub run IDs, and run URLs as `avr run view`.
|
|
11
|
+
.PP
|
|
12
|
+
Avrea CI keeps the original revision. Use --failed for failed/cancelled jobs or repeat --job for selected jobs. Their downstream dependents also rerun; other results are retained. The new attempt can be watched immediately.
|
|
13
|
+
.PP
|
|
14
|
+
.RS 4
|
|
15
|
+
.nf
|
|
16
|
+
Examples:
|
|
17
|
+
avr run rerun run-019e5a2e474e71c297e452279d4bcdea
|
|
18
|
+
avr run rerun run-019e5a2e474e71c297e452279d4bcdea --failed
|
|
19
|
+
avr run rerun run-019e5a2e474e71c297e452279d4bcdea --yes
|
|
20
|
+
avr run rerun awr-019e5a2e474e71c297e452279d4bcdea --job build --job test
|
|
21
|
+
.fi
|
|
22
|
+
.RE
|
|
23
|
+
.SH ARGUMENTS
|
|
24
|
+
.TP
|
|
25
|
+
\fIRUN\fR
|
|
26
|
+
\&
|
|
27
|
+
.SH OPTIONS
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-org\fR \fITEXT\fR
|
|
30
|
+
Organization ID or slug.
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-failed\fR
|
|
33
|
+
Re-run failed jobs and dependents; includes cancelled jobs for Avrea CI.
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-job\fR \fITEXT\fR
|
|
36
|
+
Avrea job name or ID to rerun with dependents; repeat for multiple jobs. (repeatable)
|
|
37
|
+
.TP
|
|
38
|
+
\fB\-\-idempotency\-key\fR \fIUUID\fR
|
|
39
|
+
Reuse a previous Avrea CI rerun request UUID.
|
|
40
|
+
.TP
|
|
41
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
42
|
+
Skip the confirmation prompt.
|
|
43
|
+
.SH SEE ALSO
|
|
44
|
+
.BR avr (1),
|
|
45
|
+
.BR avr-run (1),
|
|
46
|
+
.BR avr-run-cancel (1),
|
|
47
|
+
.BR avr-run-diagnose (1),
|
|
48
|
+
.BR avr-run-list (1),
|
|
49
|
+
.BR avr-run-logs (1),
|
|
50
|
+
.BR avr-run-view (1),
|
|
51
|
+
.BR avr-run-watch (1)
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
.TH AVR\-RUN\-VIEW 1 "" "avr 0.7.0" "Avrea CLI"
|
|
2
|
+
.SH NAME
|
|
3
|
+
avr-run-view \- View a workflow run with its jobs.
|
|
4
|
+
.SH SYNOPSIS
|
|
5
|
+
.B avr run view
|
|
6
|
+
[OPTIONS] [RUN]
|
|
7
|
+
.SH DESCRIPTION
|
|
8
|
+
View a workflow run with its jobs.
|
|
9
|
+
.PP
|
|
10
|
+
.RS 4
|
|
11
|
+
.nf
|
|
12
|
+
RUN accepts an Avrea run ID, a positive GitHub run ID, a GitHub Actions
|
|
13
|
+
run or job URL, or an Avrea console run URL. A job URL opens the attempt
|
|
14
|
+
that job belongs to. Without RUN, shows 10 most recent runs.
|
|
15
|
+
.fi
|
|
16
|
+
.RE
|
|
17
|
+
.PP
|
|
18
|
+
.RS 4
|
|
19
|
+
.nf
|
|
20
|
+
Examples:
|
|
21
|
+
avr run view
|
|
22
|
+
avr run view run-019e5a2e474e71c297e452279d4bcdea
|
|
23
|
+
avr run view 123456789
|
|
24
|
+
avr run view https://github.com/acme/widgets/actions/runs/123456789
|
|
25
|
+
avr run view https://github.com/acme/widgets/actions/runs/123456789/job/987654321
|
|
26
|
+
avr run view run-019e5a2e474e71c297e452279d4bcdea --steps
|
|
27
|
+
avr run view run-019e5a2e474e71c297e452279d4bcdea --log-failed
|
|
28
|
+
avr run view run-019e5a2e474e71c297e452279d4bcdea --job Build
|
|
29
|
+
avr run view run-019e5a2e474e71c297e452279d4bcdea --json conclusion,jobs
|
|
30
|
+
avr run view run-019e5a2e474e71c297e452279d4bcdea --json '*' --jq '.jobs[].job_name'
|
|
31
|
+
.fi
|
|
32
|
+
.RE
|
|
33
|
+
.PP
|
|
34
|
+
.RS 4
|
|
35
|
+
.nf
|
|
36
|
+
JSON FIELDS
|
|
37
|
+
ci_provider, workflow_name, workflow_path, conclusion, created_at, display_title, duration_seconds, event,
|
|
38
|
+
head_branch, head_sha, jobs, platform_run_id, repository, run_attempt,
|
|
39
|
+
run_id, run_number, status, triggering_actor, updated_at, workflow,
|
|
40
|
+
workflow_id
|
|
41
|
+
.fi
|
|
42
|
+
.RE
|
|
43
|
+
.SH ARGUMENTS
|
|
44
|
+
.TP
|
|
45
|
+
[\fIRUN\fR]
|
|
46
|
+
\&
|
|
47
|
+
.SH OPTIONS
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-org\fR \fITEXT\fR
|
|
50
|
+
Organization ID or slug.
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-steps\fR
|
|
53
|
+
Expand each job to show its individual steps.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-log\fR
|
|
56
|
+
Print full logs for all jobs.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-log\-failed\fR
|
|
59
|
+
Print logs only for failed steps.
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-\-job\fR \fITEXT\fR
|
|
62
|
+
Restrict view and logs to jobs whose name contains this string.
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-\-json\fR \fITEXT\fR
|
|
65
|
+
Output JSON. Pass comma-separated field names, "*" for all fields, or "?" to list available fields.
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-q\fR, \fB\-\-jq\fR \fITEXT\fR
|
|
68
|
+
Filter --json output through a jq expression.
|
|
69
|
+
.TP
|
|
70
|
+
\fB\-\-web\fR
|
|
71
|
+
Open in browser.
|
|
72
|
+
.TP
|
|
73
|
+
\fB\-\-no\-pager\fR
|
|
74
|
+
Print logs directly to stdout instead of paging through `less`. Same as setting AVR_PAGER=''.
|
|
75
|
+
.SH SEE ALSO
|
|
76
|
+
.BR avr (1),
|
|
77
|
+
.BR avr-run (1),
|
|
78
|
+
.BR avr-run-cancel (1),
|
|
79
|
+
.BR avr-run-diagnose (1),
|
|
80
|
+
.BR avr-run-list (1),
|
|
81
|
+
.BR avr-run-logs (1),
|
|
82
|
+
.BR avr-run-rerun (1),
|
|
83
|
+
.BR avr-run-watch (1)
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
.TH AVR\-RUN\-WATCH 1 "" "avr 0.7.0" "Avrea CLI"
|
|
2
|
+
.SH NAME
|
|
3
|
+
avr-run-watch \- Watch a workflow run until it completes.
|
|
4
|
+
.SH SYNOPSIS
|
|
5
|
+
.B avr run watch
|
|
6
|
+
[OPTIONS] [RUN]
|
|
7
|
+
.SH DESCRIPTION
|
|
8
|
+
Watch a workflow run until it completes.
|
|
9
|
+
.PP
|
|
10
|
+
.RS 4
|
|
11
|
+
.nf
|
|
12
|
+
RUN accepts the same Avrea IDs, GitHub run IDs, and run URLs as
|
|
13
|
+
`avr run view`. Without RUN, auto-selects the latest in-progress run.
|
|
14
|
+
Pass --repo (repeatable) to scope the auto-select to specific repositories.
|
|
15
|
+
.fi
|
|
16
|
+
.RE
|
|
17
|
+
.PP
|
|
18
|
+
NDJSON job and run completion events include ci_provider (github_actions, gitlab_ci, or avrea_ci). Native jobs have a null platform_job_id; correlate events using run_id and avrea_job_id.
|
|
19
|
+
.PP
|
|
20
|
+
.RS 4
|
|
21
|
+
.nf
|
|
22
|
+
Examples:
|
|
23
|
+
avr run watch
|
|
24
|
+
avr run watch --repo acme/web
|
|
25
|
+
avr run watch --repo a/x --repo b/y
|
|
26
|
+
avr run watch run-019e5a2e474e71c297e452279d4bcdea --exit-status
|
|
27
|
+
avr run watch run-019e5a2e474e71c297e452279d4bcdea --ndjson | jq -c .
|
|
28
|
+
.fi
|
|
29
|
+
.RE
|
|
30
|
+
.SH ARGUMENTS
|
|
31
|
+
.TP
|
|
32
|
+
[\fIRUN\fR]
|
|
33
|
+
\&
|
|
34
|
+
.SH OPTIONS
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-org\fR \fITEXT\fR
|
|
37
|
+
Organization ID or slug.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-repo\fR \fITEXT\fR
|
|
40
|
+
Scope the auto-select to a repo (org/name or rep-xxx, repeatable). Auto-detected from git remote if omitted. (repeatable)
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-exit\-status\fR
|
|
43
|
+
Exit non-zero if run failed.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-interval\fR \fIINTEGER\fR
|
|
46
|
+
Refresh interval in seconds. (default: 3)
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-ndjson\fR
|
|
49
|
+
Force NDJSON event stream (default when stdout isn't a TTY).
|
|
50
|
+
.SH SEE ALSO
|
|
51
|
+
.BR avr (1),
|
|
52
|
+
.BR avr-run (1),
|
|
53
|
+
.BR avr-run-cancel (1),
|
|
54
|
+
.BR avr-run-diagnose (1),
|
|
55
|
+
.BR avr-run-list (1),
|
|
56
|
+
.BR avr-run-logs (1),
|
|
57
|
+
.BR avr-run-rerun (1),
|
|
58
|
+
.BR avr-run-view (1)
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
.TH AVR\-RUN 1 "" "avr 0.7.0" "Avrea CLI"
|
|
2
|
+
.SH NAME
|
|
3
|
+
avr-run \- View and manage CI workflow runs.
|
|
4
|
+
.SH SYNOPSIS
|
|
5
|
+
.B avr run
|
|
6
|
+
[OPTIONS] COMMAND [ARGS]...
|
|
7
|
+
.SH DESCRIPTION
|
|
8
|
+
View and manage CI workflow runs.
|
|
9
|
+
.PP
|
|
10
|
+
.SH COMMANDS
|
|
11
|
+
.TP
|
|
12
|
+
cancel
|
|
13
|
+
Cancel an in-progress or queued workflow run.
|
|
14
|
+
.TP
|
|
15
|
+
diagnose
|
|
16
|
+
Explain a failed or unexpectedly slow workflow run.
|
|
17
|
+
.TP
|
|
18
|
+
list
|
|
19
|
+
List workflow runs for an organization.
|
|
20
|
+
.TP
|
|
21
|
+
logs
|
|
22
|
+
Fetch logs for a workflow run's jobs.
|
|
23
|
+
.TP
|
|
24
|
+
rerun
|
|
25
|
+
Re-run a completed workflow run.
|
|
26
|
+
.TP
|
|
27
|
+
view
|
|
28
|
+
View a workflow run with its jobs.
|
|
29
|
+
.TP
|
|
30
|
+
watch
|
|
31
|
+
Watch a workflow run until it completes.
|
|
32
|
+
.SH SEE ALSO
|
|
33
|
+
.BR avr (1),
|
|
34
|
+
.BR avr-artifact (1),
|
|
35
|
+
.BR avr-status (1),
|
|
36
|
+
.BR avr-pr (1),
|
|
37
|
+
.BR avr-job (1),
|
|
38
|
+
.BR avr-vm (1),
|
|
39
|
+
.BR avr-workflow (1),
|
|
40
|
+
.BR avr-cache (1),
|
|
41
|
+
.BR avr-tests (1),
|
|
42
|
+
.BR avr-sbom (1),
|
|
43
|
+
.BR avr-log (1),
|
|
44
|
+
.BR avr-auth (1),
|
|
45
|
+
.BR avr-token (1),
|
|
46
|
+
.BR avr-config (1),
|
|
47
|
+
.BR avr-settings (1),
|
|
48
|
+
.BR avr-firewall (1),
|
|
49
|
+
.BR avr-billing (1),
|
|
50
|
+
.BR avr-audit-events (1),
|
|
51
|
+
.BR avr-repo (1),
|
|
52
|
+
.BR avr-org (1),
|
|
53
|
+
.BR avr-health (1),
|
|
54
|
+
.BR avr-run-cancel (1),
|
|
55
|
+
.BR avr-run-diagnose (1),
|
|
56
|
+
.BR avr-run-list (1),
|
|
57
|
+
.BR avr-run-logs (1),
|
|
58
|
+
.BR avr-run-rerun (1),
|
|
59
|
+
.BR avr-run-view (1),
|
|
60
|
+
.BR avr-run-watch (1)
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
.TH AVR\-SBOM\-DOWNLOAD 1 "" "avr 0.7.0" "Avrea CLI"
|
|
2
|
+
.SH NAME
|
|
3
|
+
avr-sbom-download \- Download an SBOM artifact (CycloneDX, SPDX, or dependency inventory).
|
|
4
|
+
.SH SYNOPSIS
|
|
5
|
+
.B avr sbom download
|
|
6
|
+
[OPTIONS] [COMMIT]
|
|
7
|
+
.SH DESCRIPTION
|
|
8
|
+
Download an SBOM artifact (CycloneDX, SPDX, or dependency inventory).
|
|
9
|
+
.PP
|
|
10
|
+
COMMIT is the commit of a recorded SBOM, as a full SHA or a unique prefix of at least 7 characters such as the one `avr sbom list` shows. Defaults to the latest SBOM.
|
|
11
|
+
.PP
|
|
12
|
+
.RS 4
|
|
13
|
+
.nf
|
|
14
|
+
Examples:
|
|
15
|
+
avr sbom download --repo acme/api
|
|
16
|
+
avr sbom download --repo acme/api --format spdx --out api.spdx.json
|
|
17
|
+
avr sbom download 3f2c9a1b7d04 --repo acme/api --out - | jq .components
|
|
18
|
+
.fi
|
|
19
|
+
.RE
|
|
20
|
+
.SH ARGUMENTS
|
|
21
|
+
.TP
|
|
22
|
+
[\fICOMMIT\fR]
|
|
23
|
+
\&
|
|
24
|
+
.SH OPTIONS
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-\-repo\fR \fITEXT\fR
|
|
27
|
+
Repository (org/repo or rep-xxx). Auto-detected from git remote if omitted.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-org\fR \fITEXT\fR
|
|
30
|
+
Organization ID or slug. Uses default org if not specified (see: avr config set org).
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-commit\fR \fITEXT\fR
|
|
33
|
+
Same as the COMMIT argument.
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-format\fR \fICHOICE\fR
|
|
36
|
+
Artifact to download. (choices: cyclonedx, inventory, spdx; default: cyclonedx)
|
|
37
|
+
.TP
|
|
38
|
+
\fB\-\-out\fR \fITEXT\fR
|
|
39
|
+
Output file path, or "-" for stdout. Defaults to the artifact filename in the current directory.
|
|
40
|
+
.SH SEE ALSO
|
|
41
|
+
.BR avr (1),
|
|
42
|
+
.BR avr-sbom (1),
|
|
43
|
+
.BR avr-sbom-generate (1),
|
|
44
|
+
.BR avr-sbom-list (1),
|
|
45
|
+
.BR avr-sbom-view (1)
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
.TH AVR\-SBOM\-GENERATE 1 "" "avr 0.7.0" "Avrea CLI"
|
|
2
|
+
.SH NAME
|
|
3
|
+
avr-sbom-generate \- Start SBOM generation for a repository.
|
|
4
|
+
.SH SYNOPSIS
|
|
5
|
+
.B avr sbom generate
|
|
6
|
+
[OPTIONS] [REF]
|
|
7
|
+
.SH DESCRIPTION
|
|
8
|
+
Start SBOM generation for a repository.
|
|
9
|
+
.PP
|
|
10
|
+
REF is the branch, tag, or commit SHA to analyse; an abbreviated SHA such as the one `avr sbom list` shows works too. Defaults to the default-branch tip. Without --wait, commit_sha is the full SHA of the commit the run analyses when REF is a full SHA or one the API expanded.
|
|
11
|
+
.PP
|
|
12
|
+
One analysis runs per repository at a time. A request for the same ref as the analysis already running joins it; a request for a different ref is rejected (HTTP 409) until that analysis finishes. Once an SBOM has been recorded for the repository, a new run is refused (HTTP 429) for a cooldown period, and the error says how many seconds remain.
|
|
13
|
+
.PP
|
|
14
|
+
With --wait and a REF that names a commit, success means a new SBOM for that commit is downloadable, whatever the analysis task's own outcome (task_status); commit_sha and recorded_at identify it. A failed analysis can still deliver its SBOM later, so such a wait runs to --wait-timeout before reporting failure. For a branch, tag, or the default branch the API does not say which commit the run resolved, so --wait reports the analysis task's outcome only. Transient errors while waiting are retried until --wait-timeout; a wait that times out leaves the analysis running.
|
|
15
|
+
.PP
|
|
16
|
+
.RS 4
|
|
17
|
+
.nf
|
|
18
|
+
Examples:
|
|
19
|
+
avr sbom generate --repo acme/api
|
|
20
|
+
avr sbom generate v1.4.0 --repo acme/api
|
|
21
|
+
avr sbom generate 3f2c9a1b7d04 --repo acme/api --wait
|
|
22
|
+
.fi
|
|
23
|
+
.RE
|
|
24
|
+
.PP
|
|
25
|
+
.RS 4
|
|
26
|
+
.nf
|
|
27
|
+
JSON FIELDS
|
|
28
|
+
ai_task_id, commit_sha, error_code, recorded_at, status, task_status
|
|
29
|
+
.fi
|
|
30
|
+
.RE
|
|
31
|
+
.SH ARGUMENTS
|
|
32
|
+
.TP
|
|
33
|
+
[\fIREF\fR]
|
|
34
|
+
\&
|
|
35
|
+
.SH OPTIONS
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-repo\fR \fITEXT\fR
|
|
38
|
+
Repository (org/repo or rep-xxx). Auto-detected from git remote if omitted.
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-org\fR \fITEXT\fR
|
|
41
|
+
Organization ID or slug. Uses default org if not specified (see: avr config set org).
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-ref\fR \fITEXT\fR
|
|
44
|
+
Same as the REF argument.
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-wait\fR
|
|
47
|
+
Wait until generation finishes before returning.
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-wait\-timeout\fR \fIINTEGER RANGE\fR
|
|
50
|
+
Seconds to wait when --wait is set. (default: 900)
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-json\fR \fITEXT\fR
|
|
53
|
+
Output JSON. Pass comma-separated field names, "*" for all fields, or "?" to list available fields.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-q\fR, \fB\-\-jq\fR \fITEXT\fR
|
|
56
|
+
Filter --json output through a jq expression.
|
|
57
|
+
.SH SEE ALSO
|
|
58
|
+
.BR avr (1),
|
|
59
|
+
.BR avr-sbom (1),
|
|
60
|
+
.BR avr-sbom-download (1),
|
|
61
|
+
.BR avr-sbom-list (1),
|
|
62
|
+
.BR avr-sbom-view (1)
|