avr-cli 0.1.0__tar.gz

avr_cli-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Avrea
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

avr_cli-0.1.0/PKG-INFO

@@ -0,0 +1,298 @@
+Metadata-Version: 2.4
+Name: avr-cli
+Version: 0.1.0
+Summary: Avrea command-line client
+Author-email: Avrea <support@avrea.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://avrea.com/
+Project-URL: Repository, https://github.com/avrea-com/cli
+Project-URL: Bug Tracker, https://github.com/avrea-com/cli/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.3.1
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: platformdirs>=4.0
+Requires-Dist: prettytable>=3.17.0
+Requires-Dist: pydantic>=2.12.4
+Requires-Dist: typing-extensions>=4.15.0
+Requires-Dist: idna>=3.15
+Provides-Extra: dev
+Requires-Dist: pytest>=9.0.3; extra == "dev"
+Requires-Dist: pytest-asyncio>=1.3.0; extra == "dev"
+Requires-Dist: pytest-timeout>=2.4.0; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: ty==0.0.15; extra == "dev"
+Dynamic: license-file
+
+# Avrea CLI
+
+Official command-line client for [Avrea](https://avrea.com/) — `avr` brings runs, jobs, logs, and workflow control into your terminal so you don't have to bounce between tabs.
+
+## Install
+
+The Homebrew tap and PyPI package are expected to release soon.
+Until the first release is available, install from source:
+
+```sh
+git clone https://github.com/avrea-com/cli && cd cli && uv sync
+uv run avr --version
+```
+
+### Homebrew
+
+```sh
+brew install avrea-com/tap/avr
+```
+
+### PyPI
+
+```sh
+pip install avr-cli
+```
+
+Requires Python 3.14 or later.
+
+## Authenticate
+
+Browser-based login (recommended):
+
+```sh
+avr auth login
+```
+
+Show who you are and where you're pointing:
+
+```sh
+avr auth status
+avr config            # combined: host, auth, active org, default repo, all with sources
+```
+
+Log out (revokes the active API key on the server):
+
+```sh
+avr auth logout
+```
+
+For non-interactive environments (CI, scripts), set a token via env var instead — see [Configuration](#configuration).
+
+## Your first command
+
+Inside any git checkout of an Avrea-connected repository:
+
+```sh
+avr run list                           # uses git remote to scope the query
+avr run view <run-id>                  # full run with jobs
+avr run view <run-id> --log-failed     # jump straight to failed-step output
+```
+
+Auto-detection means most commands "just work" without `--repo`. Outside a git tree (or to override), pass `--repo org/name` or `--repo rep-xxx`.
+
+## Common workflows
+
+**Watch a run live**
+
+```sh
+avr run watch                          # auto-selects the latest active run for the current repo
+avr run watch <run-id>                 # specific run
+avr run watch <run-id> --exit-status   # propagate the run's success/failure into the shell exit code
+```
+
+**Triage a failure without leaving the terminal**
+
+```sh
+avr run view <run-id> --log-failed     # only the steps that failed, grouped by job
+avr run logs <run-id>                  # full log dump, paginated
+avr job logs <job-id> --follow         # tail one job in real time
+```
+
+**Trigger a workflow_dispatch**
+
+```sh
+avr workflow run ci.yml                                         # default branch
+avr workflow run ci.yml --ref feat/x -f env=staging             # with inputs
+avr workflow run "Build and Deploy" --watch --exit-status       # dispatch + watch + script-friendly exit
+echo '{"env":"prod"}' | avr workflow run deploy.yml --json      # inputs from stdin
+```
+
+WORKFLOW accepts an Avrea ID (`wfl-...`), the GitHub numeric ID, a filename (`ci.yml`, `ci`), or the display name.
+
+**SSH into a running job's VM**
+
+```sh
+avr job ssh <job-id>
+avr job ssh <job-id> --print-command   # just print the ssh string
+```
+
+**Live VM metrics while a job runs**
+
+```sh
+avr job metrics <job-id> --watch       # CPU/memory/IO gauges, refreshed every few seconds
+avr job metrics <job-id>               # static post-mortem after the job ended
+```
+
+**Cancel or rerun a run**
+
+```sh
+avr run cancel <run-id>
+avr run rerun <run-id>
+avr run rerun <run-id> --failed        # only failed jobs
+```
+
+**Workflow stats and the slowest steps**
+
+```sh
+avr workflow list                      # aggregate stats per workflow over the last 30d
+avr workflow view <wfl-id>             # per-job p95/median/failure breakdown + recent runs
+avr status                             # org-wide health: recent runs, slowest workflows, cache usage
+```
+
+**Cache**
+
+```sh
+avr cache list --repo <repo>           # entries
+avr cache usage --repo <repo>          # size vs quota
+avr cache delete --key <key> --type <type> --repo <repo>
+```
+
+## Scripting & automation
+
+Every list/view command supports `--json` for structured output.
+
+**Discover available fields**
+
+```sh
+avr run list --json '?'                # prints the field schema
+```
+
+**Select specific fields**
+
+```sh
+avr run list --json status,conclusion,head_branch
+avr run list --json '*'                # all fields
+```
+
+**Pipe through `jq`**
+
+```sh
+avr run list --json '*' -q '.[] | select(.conclusion == "failure") | .run_id'
+avr workflow list --json name,runs -q '.[] | "\(.runs)\t\(.name)"'
+```
+
+`-q/--jq` is built in (no need to pipe to `jq` yourself), but the schema-projected output is also `jq`-friendly.
+
+**Detect "auth required" in scripts**
+
+```sh
+avr run list >/dev/null
+case $? in
+  0) ;;
+  4) echo "logged out, re-auth needed"; exit 4 ;;
+  *) echo "transient failure" ;;
+esac
+```
+
+Exit code `4` is reserved for "auth required". `1` is general failure; `2` is a usage error.
+
+**Pipe-aware output**
+
+When stdout isn't a TTY, list commands switch to tab-separated rows (no color, no truncation, ISO timestamps), so `avr run list | awk` works without flags. `avr run watch | jq -c .` automatically switches to NDJSON event mode.
+
+## Configuration
+
+### Environment variables
+
+| Variable         | Purpose                                                                                          |
+| ---------------- | ------------------------------------------------------------------------------------------------ |
+| `AVR_HOST`       | Avrea API URL. Defaults to the active host in `hosts.json`, then `https://api.avrea.com`.        |
+| `AVR_TOKEN`      | API key. Overrides whatever's stored for the active host.                                         |
+| `AVR_ORG`        | Default organization ID. Overrides the stored default.                                           |
+| `AVR_REPO`       | Default repository (`org/name` or `rep-xxx`). Overrides git auto-detect.                          |
+| `AVR_BROWSER`    | Browser to launch for `--web` and OAuth login. Falls back to `BROWSER`, then system default.      |
+| `AVR_PAGER`      | Pager for long output. Overrides `PAGER`. Set to empty string to disable paging.                  |
+| `AVR_LINKS`      | Set to `0` to disable OSC 8 hyperlinks. Same as `--no-links`.                                     |
+| `AVR_DEBUG`      | Comma-separated debug categories. Set to `1`/`true` for general debug logging.                    |
+| `AVR_PROMPT_DISABLED` | Refuse interactive prompts (scripts fail fast instead of hanging on stdin).                  |
+| `AVR_CONFIG_DIR` | Override the config directory. Defaults to `$XDG_CONFIG_HOME/avrea` or `~/.config/avrea`.         |
+| `AVR_MACOS_NATIVE_PATHS` | Set to `1` on macOS to use `~/Library/...` instead of the default `~/.config/avrea`.       |
+| `NO_COLOR`       | Disable colored output (any non-empty value). Same as `--no-color`.                                |
+
+### Config commands
+
+```sh
+avr config                        # status: host, auth, org, repo with sources
+avr config list                   # same as bare `avr config`
+avr config set org <org-id>       # store a default organization
+avr config get org
+avr config unset org
+```
+
+Persistent state lives in `$XDG_CONFIG_HOME/avrea/hosts.json` (host-keyed credentials and per-host defaults).
+
+### Switching hosts
+
+```sh
+avr auth switch                   # interactive picker across stored hosts
+AVR_HOST=https://beta.api.avrea.com avr run list   # one-shot override
+```
+
+## Tips
+
+**Open anything on the console**
+
+```sh
+avr run view <run-id> --web
+avr workflow view <wfl-id> --web
+avr cache list --repo <repo> --web
+```
+
+**Click-to-open in your terminal**
+
+IDs in tables are wrapped in OSC 8 hyperlinks — clicking opens the matching console page in your browser (supported by iTerm2, Kitty, WezTerm, Ghostty, GNOME Terminal, Konsole, Windows Terminal, and most modern terminals). Disable with `--no-links` or `AVR_LINKS=0` if your terminal renders them as visible garbage.
+
+**Tab completion**
+
+```sh
+# bash
+eval "$(_AVR_COMPLETE=bash_source avr)"
+# zsh
+eval "$(_AVR_COMPLETE=zsh_source avr)"
+# fish
+_AVR_COMPLETE=fish_source avr | source
+```
+
+**Verbose mode**
+
+```sh
+avr -v run list                   # prints HTTP requests, useful for debugging
+```
+
+**Filter the help surface**
+
+```sh
+avr --help                        # top-level groups
+avr <group> --help                # subcommands
+avr <group> <command> --help      # full flag list with examples
+```
+
+## Documentation
+
+- Full command reference: [`docs/REFERENCE.md`](./docs/REFERENCE.md) (also available as `man avr`)
+- Online docs: [docs.avrea.com/cli](https://docs.avrea.com/cli)
+- Print the same reference inline: `avr --help` and `avr <command> --help`
+
+## Contributing and reporting issues
+
+- Bug reports and feature requests: [github.com/avrea-com/cli/issues](https://github.com/avrea-com/cli/issues)
+
+## Reporting a vulnerability
+
+If you believe you have found a security issue in `avr`, please contact <security@avrea.com>.
+
+## License
+
+Licensed under the [Apache License, Version 2.0](./LICENSE). Copyright 2026 Avrea.