Skip to main content

Relay-kit public installer CLI for coding-agent runtime generation.

Project description

English | Tiếng Việt

Relay-kit

Relay-kit is a workflow operating system for teams that build with coding agents.

It does not try to make the model magically smarter. It makes the work more disciplined.

With Relay-kit, an agent gets:

  • a clearer starting point
  • better reusable skills
  • a stricter way to plan, build, debug, and review
  • shared artifacts so work does not live only in chat memory

The result is simple: agents work with more structure, fewer random moves, and stronger proof before anything is called done.

5-minute start

For users who just want to install Relay-kit and generate one runtime:

pipx install "git+https://github.com/b0ydeptraj/Relay-kit.git"
relay-kit init "C:\\path\\to\\my-app" --codex
relay-kit doctor "C:\\path\\to\\my-app"

Use one adapter flag per run. Replace --codex with --claude or --antigravity when that is the target agent. The default install is the full enterprise governance bundle. Use --baseline only when you want the smaller first-install surface.

For a local repo checkout:

pipx install .
relay-kit init /path/to/project --codex
relay-kit doctor /path/to/project

Why use Relay-kit

Most agent workflows break in the same places:

  • work starts before the problem is clear
  • implementation drifts away from the approved direction
  • bugs get patched without finding the root cause
  • "done" gets claimed before there is enough proof

Relay-kit exists to stop that.

It is for:

  • solo builders using coding agents seriously
  • product and engineering teams that want repeatable output
  • people using Claude, Codex, or Antigravity-style agent workflows who need more than prompt packs

Relay-kit gives them a clear operating flow for:

  • new work
  • bug fixing
  • review
  • completion

It makes agents behave less like improvising interns and more like engineers working inside a defined system.

What you get

  • a small public skill surface that is easy to remember
  • reusable runtime skills for .claude, .agent, and .codex
  • shared workflow artifacts in .relay-kit/
  • a read-only memory-search utility for retrieving prior decisions and handoffs
  • a release-readiness utility for pre/post deploy smoke gates and rollback signals
  • an accessibility-review gate so frontend quality is not only visual
  • a skill-gauntlet regression gate to keep skill routing behavior stable
  • a context-continuity utility for checkpoint, rehydrate, handoff, and diff flows
  • a readiness check gate that combines tests, doctor, policy, manifest trust, upgrade, support, contract sync, and signal export proof
  • local Pulse reports and signal exports for quality review and support diagnostics
  • an active baseline that is validated instead of loosely assembled
  • a way to make work more consistent without forcing everything through raw chat memory

Useful commands

List active bundles without legacy migration-only noise:

relay-kit --list-skills

Show preserved legacy suites only when you need migration/debug detail:

relay-kit --list-skills --show-legacy

Generate all active adapters:

relay-kit init /path/to/project --all

Run the enterprise governance gates after the default full install:

relay-kit init /path/to/project --all
relay-kit manifest write /path/to/project
relay-kit manifest stamp /path/to/project --issuer relay-kit --channel enterprise
relay-kit doctor /path/to/project --policy-pack enterprise
relay-kit upgrade mark-current /path/to/project --adapter all
relay-kit readiness check /path/to/project --profile enterprise

Run the support gate:

relay-kit doctor /path/to/project
relay-kit manifest verify /path/to/project --trusted
relay-kit doctor /path/to/project --policy-pack enterprise

Show recent gate evidence:

relay-kit evidence summary /path/to/project
relay-kit doctor /path/to/project --json

Doctor writes local JSONL events to .relay-kit/evidence/events.jsonl.

Export planning and QA contracts as machine-readable JSON:

relay-kit contract export /path/to/project
relay-kit contract import /path/to/project --contract-file /path/to/relay-contract.json
relay-kit contract import /path/to/project --contract-file /path/to/relay-contract.json --apply

Write and verify the bundle checksum manifest:

relay-kit manifest write /path/to/project
relay-kit manifest verify /path/to/project
relay-kit manifest stamp /path/to/project --issuer relay-kit --channel enterprise
relay-kit manifest verify /path/to/project --trusted

Run policy guard packs:

relay-kit policy list
relay-kit policy check /path/to/project --pack enterprise --strict

Prepare a support diagnostics bundle:

relay-kit support bundle /path/to/project --policy-pack enterprise
relay-kit support request /path/to/project --severity P1 --policy-pack enterprise --json
relay-kit support triage /path/to/project --strict --json

When the support request artifact already exists, the support bundle includes a redacted support-request summary for triage. support triage reads the request and bundle artifacts together before the case is handed to paid support.

Build a local Pulse quality report:

relay-kit pulse build /path/to/project
relay-kit pulse build /path/to/project --include-readiness --json
relay-kit pulse build /path/to/project --support-request-file .relay-kit/support/support-request.json
relay-kit pulse build /path/to/project --history-limit 50

Pulse includes a gate summary for workflow eval, readiness, publication, support request, and evidence ledger status so dashboard review can see which gate is pass, attention, hold, or not-run. The report also includes gate details for degraded scenarios, findings, diagnostics, and failed evidence events.

Export Pulse and evidence ledger signals:

relay-kit signal export /path/to/project
relay-kit signal export /path/to/project --json

Run the paid/team readiness gate:

relay-kit readiness check /path/to/project --profile enterprise
relay-kit readiness check /path/to/project --profile enterprise --json

Verify local release-lane prerequisites:

relay-kit release verify /path/to/project
relay-kit release verify /path/to/project --json

Plan and record package publication evidence:

relay-kit publish trail /path/to/project --channel pypi --json
relay-kit publish plan /path/to/project --channel pypi --json
relay-kit publish evidence /path/to/project --channel pypi --twine-check-file .tmp/twine-check.txt --upload-log-file .tmp/upload-log.txt --publication-plan-file .relay-kit/release/publication-plan.json --json
relay-kit publish status /path/to/project --strict --json

Measure workflow routing quality with bundled scenarios:

relay-kit eval run /path/to/project --strict
relay-kit eval run /path/to/project --json --output-file workflow-eval.json
relay-kit eval run /path/to/project --strict --baseline-file previous-workflow-eval.json

The bundled default eval suite covers 28 production/team scenarios across orchestration, hubs, utility providers, specialists, and runtime diagnostics.

Track installed runtime version and print upgrade actions:

relay-kit manifest write /path/to/project
relay-kit upgrade mark-current /path/to/project --bundle baseline --adapter codex
relay-kit upgrade check /path/to/project --strict
relay-kit upgrade plan /path/to/project

Maintainer-only core entrypoint:

python relay_kit.py /path/to/project --bundle baseline --ai codex --emit-contracts --emit-docs --emit-reference-templates

Start flow

If you only remember a few names, remember these:

Goal Public name Behind the scenes
find the right path start-here workflow-router
shape a rough idea brainstorm brainstorm-hub
turn approved work into buildable steps write-steps scrum-master
implement the approved slice build-it developer
review a branch or PR before merge or sign-off review-pr review-hub
debug without guessing debug-systematically debug-hub + root-cause-debugging
decide if work is actually ready ready-check review-hub + qa-governor
force a final proof pass prove-it evidence-before-completion

Default path for new work:

  1. start-here
  2. brainstorm
  3. write-steps
  4. build-it
  5. ready-check

Default path for bugs:

  1. start-here
  2. debug-systematically
  3. build-it
  4. ready-check

Default path for branch or PR review:

  1. review-pr
  2. ready-check if you need a real readiness or shipability verdict
  3. prove-it if the completion claim still sounds stronger than the proof

Use prove-it for a narrow claim-to-evidence pass. Use ready-check when you need a go / no-go readiness verdict and qa-report.md.

More detail:

How it works

Relay-kit separates the work into a small number of reliable stages:

  1. route the request
  2. clarify or investigate
  3. slice the work into safe steps
  4. implement with evidence
  5. review before calling it done

Under the hood, the system uses runtime skills plus shared state, contracts, references, and docs in .relay-kit/.

Configuration

Main entrypoints:

  • relay_kit.py
  • relay_kit_legacy.py

Current active baseline:

  • baseline
  • compatibility alias: baseline-next

Generated output includes:

  • .codex/skills/
  • .claude/skills/
  • .agent/skills/
  • .relay-kit/contracts/
  • .relay-kit/state/
  • .relay-kit/references/
  • .relay-kit/docs/

Generate all active adapter runtimes together with --ai all:

python relay_kit.py . --bundle baseline --ai all

Migration status

Phase 3 cutover is active and canonical runtime paths are now:

  • relay_kit.py
  • relay_kit_legacy.py
  • .relay-kit/
  • .relay-kit-prompts/

Historical compatibility timeline and removal log:

Public docs index

Deeper docs

Legacy note

Legacy kits still exist for migration and compatibility work. They are not the main Relay-kit runtime story.

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

relay_kit-3.4.1.tar.gz (206.4 kB view details)

Uploaded Source

Built Distribution

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

relay_kit-3.4.1-py3-none-any.whl (201.4 kB view details)

Uploaded Python 3

File details

Details for the file relay_kit-3.4.1.tar.gz.

File metadata

  • Download URL: relay_kit-3.4.1.tar.gz
  • Upload date:
  • Size: 206.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for relay_kit-3.4.1.tar.gz
Algorithm Hash digest
SHA256 5e99b8c61fa2986603733056a5fa9a591173cb1fc57ce8633565ba53b446461d
MD5 b87fb513925c20a3ce49b79f884b75f6
BLAKE2b-256 9c6d66429c9211ebd6de92db5e2b4a3180165ed070e3fe4ffdff501c25974167

See more details on using hashes here.

File details

Details for the file relay_kit-3.4.1-py3-none-any.whl.

File metadata

  • Download URL: relay_kit-3.4.1-py3-none-any.whl
  • Upload date:
  • Size: 201.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for relay_kit-3.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 36427b1793071ee59c1b672ef8e91332760d9bd1651472e6fa7ee18f8359e6e3
MD5 9ceecfdef1872ac422d810c9fad283c0
BLAKE2b-256 4e3a5d271d87bcffc86d7f5953c1195321f9e86d93209e748f34cf48aa459dc5

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