Skip to main content

CLI for the Assertion API

Project description

Assertion CLI

CLI for the Assertion API.

Usage

The CLI targets https://app.tryassertion.com by default; set ASSERTION_BASE_URL (e.g. http://localhost:8000) to point at another backend.

Run locally from the workspace:

uv run --package assertion-cli asrt --help

Install as a uv tool from PyPI:

uv tool install assertion-cli              # latest
uv tool install --reinstall assertion-cli  # upgrade in place

The CLI package declares all of its direct runtime dependencies. At the moment that set is httpx, pydantic, and typer.

After installation:

asrt install                           # one-time onboarding: write skill files, AGENTS.md/CLAUDE.md pointer, .gitignore
asrt login                             # authenticate this repo (generate a token at Settings → Authentication)
asrt session start                     # per work session: record the diff base (current HEAD)
asrt stacks
asrt checkpoint --stack <stack-id> "Implemented X\nUpdated Y"
asrt checkpoint --continue "Implemented Y"
asrt decision --yes <checkpoint-id>   # optional, only after a failed checkpoint
asrt verify                            # submit final verification (non-blocking)
asrt verify --force                    # submit even when review diff is unchanged
asrt verify-status                     # one-shot poll; loop with your own sleep until terminal

Authentication

asrt login stores your API token in a global, user-level file — ~/.assertion/credentials.json (mode 0600) — with an inverted repo index:

{
  "version": 2,
  "tokens": { "alk_...": ["acme/mvp", "acme/docs"] },
  "repo_index": { "acme/mvp": "alk_...", "acme/docs": "alk_..." }
}

Run it from inside the repo it should authenticate. It validates the token and confirms the repo's origin remote is connected to a stack in the token's workspace before saving the token against that workspace's stack repos, so each repo can target a different workspace while moved folders and fresh clones keep working. asrt logout removes the current repo's saved auth; asrt whoami shows which token is in effect.

Token resolution at call time, in order:

  1. the token in repo_index for the current repo's GitHub owner/repo;
  2. the ASSERTION_API_TOKEN environment variable (a backup for CI, or repos with no remote that asrt login won't store);

with a clear "run asrt login" error when neither is present. The API base URL defaults to https://app.tryassertion.com; override it with ASSERTION_BASE_URL for a local backend.

Publishing a new version

  1. Bump the version in cli/pyproject.toml.
  2. Commit and push to main.

That's it. The Publish CLI to PyPI workflow auto-triggers on pushes that change cli/pyproject.toml. It reads the version from the file, runs tests, builds, publishes to PyPI, and pushes a cli-v<version> tag.

If the version hasn't changed (e.g. you updated a dependency), the workflow skips publishing — only version bumps trigger a publish.

You can also trigger the workflow manually from the GitHub Actions UI — it reads the version from the current pyproject.toml on main.

Prerequisite: PYPI_TOKEN must be set as a GitHub Actions secret — a PyPI API token with upload scope for assertion-cli.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

assertion_cli-0.5.19.tar.gz (46.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

assertion_cli-0.5.19-py3-none-any.whl (35.3 kB view details)

Uploaded Python 3

File details

Details for the file assertion_cli-0.5.19.tar.gz.

File metadata

  • Download URL: assertion_cli-0.5.19.tar.gz
  • Upload date:
  • Size: 46.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for assertion_cli-0.5.19.tar.gz
Algorithm Hash digest
SHA256 b49e11ece42c7d05410a00ff042439234b74cec921ef40cef9d6e355a769ead9
MD5 e3f1cf0f9d3f591db152451770d2aa2a
BLAKE2b-256 fcf63b2a1dacac62cda4726bf8e643509e1fcec490d48c32f24dbf7514642e4b

See more details on using hashes here.

File details

Details for the file assertion_cli-0.5.19-py3-none-any.whl.

File metadata

  • Download URL: assertion_cli-0.5.19-py3-none-any.whl
  • Upload date:
  • Size: 35.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for assertion_cli-0.5.19-py3-none-any.whl
Algorithm Hash digest
SHA256 7aefbbc5f31244da555d99978279063601b472a7ec21237cc0dd3d37658bddee
MD5 4f4fef8dccd929557daf8b3b7028412a
BLAKE2b-256 4c31bad27ece5eedb5ff5e2703ab91e98116659877bb7ebb225f086a69ea7732

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page