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 new                               # reset local run state for a fresh session
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-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) — keyed by the repo's path:

{ "version": 1, "repos": { "/abs/path/to/repo": "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, so each repo can target a different workspace. Because entries are keyed by path, moving or renaming the repo folder means logging in again (which adds a new entry). asrt logout removes the current repo's entry; asrt whoami shows which token is in effect.

Token resolution at call time, in order:

  1. the entry for the current repo path in ~/.assertion/credentials.json;
  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.14.tar.gz (41.1 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.14-py3-none-any.whl (32.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: assertion_cli-0.5.14.tar.gz
  • Upload date:
  • Size: 41.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","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.14.tar.gz
Algorithm Hash digest
SHA256 060b2be4842610c9f2b8f895ff5bd177959855efca148478a81f3e111d87b54e
MD5 4bcee56091cbbba0ed59dc7c65c4889c
BLAKE2b-256 e860706e621dabd7be40846e616ad336e23ec1c7c975add137fc8d8cc963f37d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: assertion_cli-0.5.14-py3-none-any.whl
  • Upload date:
  • Size: 32.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","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.14-py3-none-any.whl
Algorithm Hash digest
SHA256 666a35642b3b2b69b68fa73db182879e361dba46c890a372db7abdc9b65a7ef5
MD5 96885a8a03241a989ac48cf4995d2577
BLAKE2b-256 4b7397efc5cfc71d3ac087fc0f44247d129938448530f2061a8db6769ef81424

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