Skip to main content

CLI for the Aethis developer API — author, test, and publish rule bundles

Project description

aethis-cli

PyPI Docs License: MIT

CLI for the Aethis developer API — evaluate eligibility, author rule bundles, and publish from the terminal.

Install

# Recommended — isolated, no venv juggling:
uv tool install aethis-cli

# Or, with pipx:
pipx install aethis-cli

# Or in a venv:
python -m venv .venv && source .venv/bin/activate
pip install aethis-cli

Quick start

No sign-up needed. Decision tools work immediately.

# Evaluate eligibility against a published bundle
aethis decide -b <bundle_id> -i '{"space.crew.age": 35, "space.medical.cert_valid": true}'

# Inspect the input fields a bundle expects
aethis fields -b <bundle_id>

# Get human-readable rule descriptions
aethis explain -b <bundle_id>

Author your own rules

Rule authoring is invite-only private beta. Decision tools (aethis decide, aethis fields, aethis explain) work immediately with no sign-up — this section is for approved beta tenants. Request access →

# 1. Authenticate (creates a key via browser sign-in)
aethis account generate
# Or paste an existing key: aethis login

# 2. Initialise a project
mkdir my-rules && cd my-rules
aethis init

# 3. Add source documents and guidance
#    (put PDFs/text in .aethis/sources/, hints in .aethis/guidance/hints.yaml)

# 4. Generate a rule bundle
aethis generate

# 5. Run test cases
aethis test

# 6. Publish the bundle
aethis publish

Try the example

A complete, runnable example is included in examples/spacecraft-crew-rules/:

cp -r examples/spacecraft-crew-rules my-first-rules && cd my-first-rules
aethis account generate
aethis generate --poll
aethis test
aethis decide -i '{"space.crew.species": "Human", "space.crew.age": 35, "space.crew.flight_hours": 600, "space.crew.has_pilot_license": true, "space.crew.has_gaa_exam": true, "space.medical.cert_valid": true, "space.mission.type": "suborbital", "space.crew.has_towel": true}'

See examples/spacecraft-crew-rules/README.md for details.

Commands

Decision (no API key required)

Command Description
aethis decide -b <bundle_id> -i '<json>' Evaluate eligibility. Add --explain for trace output.
aethis fields -b <bundle_id> Show input fields the bundle expects
aethis explain -b <bundle_id> Human-readable rule descriptions

Authoring

Command Description
aethis init Initialise a new project in the current directory
aethis generate [--poll] Upload sources + guidance, trigger generation
aethis status Check generation job progress
aethis test Run test cases against the latest bundle
aethis publish [--force] Set the latest bundle as active

Guidance (project-level)

Project guidance lives in .aethis/guidance/hints.yaml and is uploaded by aethis generate. These commands manage hints server-side after upload.

Command Description
aethis guidance list List active hints for the current project
aethis guidance export <file> Export the current project's hints to YAML
aethis guidance import <file> Import hints from a YAML file
aethis guidance deactivate <hint_id> Deactivate a specific hint

Projects & bundles

Command Description
aethis projects list List your projects
aethis projects show <project_id> Show project details
aethis projects archive <project_id> Archive a project
aethis bundles list List published bundles
aethis bundles archive <bundle_id> Archive a bundle

Account

Command Description
aethis account generate Create an API key via browser sign-in
aethis account keys List your API keys (masked)
aethis account revoke <key_id> Revoke a key
aethis login Paste an existing key

Project structure

After aethis init, your project looks like:

my-rules/
  .aethis/
    aethis.yaml          # project config
    state.json           # tracked IDs (project, bundle, job)
    sources/             # PDF/text source documents
    guidance/
      hints.yaml         # guidance hints for the code synthesizer
    tests/
      scenarios.yaml     # golden test cases

aethis.yaml

project: my-rules
api_key_env: AETHIS_API_KEY

scenarios.yaml

tests:
  - name: "Eligible  all requirements met"
    inputs:
      space.crew.age: 35
      space.crew.flight_hours: 600
      space.crew.has_pilot_license: true
    expect:
      outcome: eligible
  - name: "Not eligible  no medical cert"
    inputs:
      space.medical.cert_valid: false
    expect:
      outcome: not_eligible

Environment variables

Variable Description Required Default
AETHIS_API_KEY Your API key (ak_live_...) Authoring only

Extending with plugins

aethis-cli discovers third-party plugins via Python entry points under the aethis_cli.plugins group. A plugin is any installed package that exposes a register(app: typer.Typer) -> None callable; at startup the CLI calls it with the root Typer app and the plugin attaches extra commands.

Example pyproject.toml:

[project.entry-points."aethis_cli.plugins"]
my_plugin = "my_package.plugin:register"

Example my_package/plugin.py:

import typer

def register(app: typer.Typer) -> None:
    @app.command()
    def hello() -> None:
        typer.echo("hello from my plugin")

Staff-only tools (DSL source viewer, IAM registry, domain-guidance management, --base-url override) live in the private aethis-cli-internal package, installed on request.

Development

git clone https://github.com/aethis-ai/aethis-cli.git
cd aethis-cli
pip install -e ".[dev]"
pytest tests/ -v

Shell completions

# Install tab completion for your shell
aethis --install-completion bash   # or zsh, fish, powershell

Troubleshooting

aethis generate times out but server continues The server finishes even if your client disconnects. Wait 10–15 min, then run aethis bundles list — if the bundle appeared, run aethis test and aethis publish. Do not re-trigger generation; that creates a duplicate run.

aethis publish fails with "tests are failing" publish refuses a bundle with failing tests. Fix with guidance + regenerate, or pass --force (not recommended for production).

422 Validation error on aethis decide DATE fields must be passed as integer ordinals, not ISO strings. 2025-04-13739354:

python3 -c "from datetime import date; print(date(2025,4,13).toordinal())"

Auth error: … Your API key is missing, expired, or revoked. Run aethis login to paste a new one, or aethis account generate to create one.

403 Forbidden: missing scope Your key lacks the required scope for the command. aethis whoami shows what your current key can do. Contact support to upgrade scopes.

Benchmarks

See how the engine compares to frontier LLMs on real-world eligibility rules: aethis-examples

License

MIT

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

aethis_cli-0.4.3.tar.gz (45.3 kB view details)

Uploaded Source

Built Distribution

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

aethis_cli-0.4.3-py3-none-any.whl (40.6 kB view details)

Uploaded Python 3

File details

Details for the file aethis_cli-0.4.3.tar.gz.

File metadata

  • Download URL: aethis_cli-0.4.3.tar.gz
  • Upload date:
  • Size: 45.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for aethis_cli-0.4.3.tar.gz
Algorithm Hash digest
SHA256 726b9e771b611a657aa2e40ca5aa54d18b497056a9c0e84707a63994917d942c
MD5 d25f1f5b4316cbec44ff9ce0cd50d18b
BLAKE2b-256 ae10e9333d282e5aec80967a227bfcc31154053558293cbab83a7eed774188d5

See more details on using hashes here.

Provenance

The following attestation bundles were made for aethis_cli-0.4.3.tar.gz:

Publisher: publish.yml on Aethis-ai/aethis-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aethis_cli-0.4.3-py3-none-any.whl.

File metadata

  • Download URL: aethis_cli-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 40.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for aethis_cli-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ed26d819f06602e95b3a63149d3d85499ccbc50d01e09f73980e1cf6e02597b1
MD5 378d186b0fc8f5b5134700a00459d297
BLAKE2b-256 cfd46c6abec2c3e1ccce49b62539ae7d9dadc7a0884fe78cb8c304e4c450976d

See more details on using hashes here.

Provenance

The following attestation bundles were made for aethis_cli-0.4.3-py3-none-any.whl:

Publisher: publish.yml on Aethis-ai/aethis-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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