Skip to main content

AI-assisted CLI release manager powered by Backboard

Project description

Rel-Ease

Rel-Ease (release-cli on PyPI) is a terminal release manager that pairs a Click CLI with a Backboard assistant. The LLM reads your diff, proposes SemVer bumps, updates release_notes.md, stages commits, and for Python packages runs uv build and twine upload — all through explicit tools you control.

Requirements

  • Python 3.11+
  • git, BACKBOARD_API_KEY
  • Python projects: uv, twine (and PyPI credentials via TWINE_USERNAME / TWINE_PASSWORD or standard twine config)
  • Node/TypeScript: npm (for npm install --package-lock-only after version bumps)
  • Rust: manual cargo publish after the assistant bumps Cargo.toml and commits (by design)

Install

cd rel-ease
uv sync
uv pip install -e .
# or: uv tool install .

Quick start

export BACKBOARD_API_KEY=sk-...

# Sanity-check environment and repo detection
rel-ease doctor .

# Show how the project is classified (no network)
rel-ease detect .

# Run the release assistant (creates/updates Backboard assistant named `rel-ease`)
rel-ease release .

# Read-only rehearsal
rel-ease release . --dry-run

# Extra guidance for the model
rel-ease release . --hint "User asked for a minor bump for the new API."

Optional: set REL_EASE_ASSISTANT_ID to pin a specific Backboard assistant UUID after the first run.

Repo detection (deterministic)

Order of precedence from the repository root:

  1. RustCargo.toml with a [package] version
  2. Pythonpyproject.toml with [project].version
  3. Node/TSpackage.json with version

If the kind is Python, uv_build and twine_upload run for real. For Node or Rust, those tools return a skipped result so the model does not pretend PyPI ran.

Tools exposed to the assistant

Tool Role
get_repo_context Refresh kind, version file, current version
increment_version Bump patch / minor / major or set explicit_version
git_diff git diff with optional --stat and path filters
git_status_files Porcelain status per path
git_add Stage explicit paths
git_commit Commit with your message
uv_build Clean dist/ and uv build (Python only)
release_notes_update Create/update release_notes.md (replace or append)
twine_upload Upload artifacts from dist/ (Python only)

The Backboard model interprets diffs and drives the sequence; every mutation goes through these tools on your machine.

Environment

Variable Purpose
BACKBOARD_API_KEY Required for rel-ease release
REL_EASE_ASSISTANT_ID Optional UUID override
TWINE_USERNAME / TWINE_PASSWORD PyPI upload (if not using another twine config)

What Rel-Ease does not do

  • No automatic git push, tags, or GitHub releases (keep using gh or CI).
  • No cargo publish wrapper yet — the assistant will remind you after a Rust bump.

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

release_cli-0.5.0.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

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

release_cli-0.5.0-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

Details for the file release_cli-0.5.0.tar.gz.

File metadata

  • Download URL: release_cli-0.5.0.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for release_cli-0.5.0.tar.gz
Algorithm Hash digest
SHA256 184e82089eba9cbd7ccace85be5edd5bbacb207cd0dfbc275c397618e54bde40
MD5 b3d3bb29be5dcb913e68544fcd743f44
BLAKE2b-256 75847303e1fa4dfc78a0606e577433d1d996dd35ecf658109f17b9068b8db7db

See more details on using hashes here.

File details

Details for the file release_cli-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: release_cli-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 16.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for release_cli-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d82883625d3a3f3748708c6cfdfdbc242f8363cfb2effa8389efb97ab4516791
MD5 bbd532e8de2c6b004fa18f694e8f80a9
BLAKE2b-256 a6bb11c328878f8fe0eeab020659ebb112c4eff53d8719576ccf7f552fe1a3fc

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