Skip to main content

AgentJoy Bridge CLI (Codex / Claude Code / Agent tool activity -> AgentJoy Runs)

Project description

agentjoy-bridge

AgentJoy Bridge is a tiny, dependency-free CLI that converts agent/tool activity into AgentJoy Run events.

It supports:

  • OpenAI Codex CLI (codex exec --json)
  • Claude Code hooks / plugin hooks
  • (Template included) ChatGPT Apps SDK viewer (MCP)

Install

pipx install agentjoy-bridge
# or: pip install agentjoy-bridge

Windows (PATH): if agentjoy command is not found, run via module:

py -m agentjoy_bridge init --api http://127.0.0.1:8000 --open

Doctor (diagnostics)

If setup is confusing (PATH, backend, config), run:

agentjoy doctor

It prints:

  • backend reachability (/health)
  • config/profile status
  • whether your API key / user token work

Optional (creates a small run):

agentjoy doctor --write-test

Secrets are redacted in the output.


Profiles (multiple environments)

You can keep multiple connection settings (local/staging/prod) and switch:

agentjoy profile set local --api http://127.0.0.1:8000 --use
agentjoy profile set staging --api https://staging.example.com --api-key ... --user-token ...

agentjoy profile list
agentjoy profile use staging
agentjoy profile show staging

For one-off commands without switching the current profile:

agentjoy demo --profile local --open
agentjoy health --profile staging

3-minute Quickstart (no Codex required)

Fastest: one command onboarding

If you're running from the AgentJoy repo (so ./backend exists), this command can:

  • start backend (if needed)
  • create a workspace + save config
  • create a demo run + open the share URL
agentjoy quickstart --api http://127.0.0.1:8000 --open

Windows (PATH):

py -m agentjoy_bridge quickstart --api http://127.0.0.1:8000 --open

1) Start AgentJoy backend

cd backend
python -m uvicorn agentjoy.main:app --reload --port 8000

2) Bootstrap a Workspace + save config

This creates a workspace and stores config at ~/.agentjoy/config.json.

agentjoy init --api http://127.0.0.1:8000 --open
# (alias: --api-base)

3) Create a demo run + open the share URL

agentjoy demo --open

Codex (recommended)

agentjoy codex-run "Fix failing tests"

It will print a share URL you can open in a browser.


Claude Code

See integrations/claude-plugin/agentjoy/ for hook configs and examples.


Compatibility: upstream JSON changes

LLM tools evolve quickly. If a new Claude/Codex version changes the JSON field names that the Bridge reads, you can adjust the extraction paths without waiting for a package release.

  1. Create a template overrides file:
agentjoy adapters --init
agentjoy adapters
  1. Edit the file shown (typically ~/.agentjoy/bridge_adapters.json) and add new dot-paths.

This feature is intentionally lightweight: unknown fields are ignored, and the Bridge keeps running.


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

agentjoy_bridge-0.3.6.tar.gz (25.6 kB view details)

Uploaded Source

Built Distribution

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

agentjoy_bridge-0.3.6-py3-none-any.whl (25.1 kB view details)

Uploaded Python 3

File details

Details for the file agentjoy_bridge-0.3.6.tar.gz.

File metadata

  • Download URL: agentjoy_bridge-0.3.6.tar.gz
  • Upload date:
  • Size: 25.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for agentjoy_bridge-0.3.6.tar.gz
Algorithm Hash digest
SHA256 af87c2cca18bad8524d2120419e3ebe76ce06893eb1beaaa5ad0538e58577e46
MD5 d7aa3a6aa3b2150675198e7c703d5b25
BLAKE2b-256 fb0c7c7bf01e1d75715fb967811b2630e57b363a8b83453541de025eccd29a46

See more details on using hashes here.

File details

Details for the file agentjoy_bridge-0.3.6-py3-none-any.whl.

File metadata

File hashes

Hashes for agentjoy_bridge-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 cc60f1bef18feda22d75d8b9996e872b639409383d9fb2547ec8a928eb209fb4
MD5 cf063cee864be04817ca9a0240b19b06
BLAKE2b-256 1a873052efc9a03b8794d7ed0c48062d02c7897a86081b283c74554c1b788200

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