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.20.tar.gz (27.3 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.20-py3-none-any.whl (26.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: agentjoy_bridge-0.3.20.tar.gz
  • Upload date:
  • Size: 27.3 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.20.tar.gz
Algorithm Hash digest
SHA256 4a3014bbda578724ab65714ac8db729a3fb12c5931e38614d71f2bee84ebdf90
MD5 e462fa57d827c6b8ecb813a1fcaee090
BLAKE2b-256 61413cfb1e599ee501444cb2f3b4361fd838b70850baf8a51d73a1550f228010

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for agentjoy_bridge-0.3.20-py3-none-any.whl
Algorithm Hash digest
SHA256 b33a1cd9b9d3d49850a5a8cb47eebe955e3b60aee50f3da36859871ff54180aa
MD5 c03e5f6a8de4155a780e089db0c891ce
BLAKE2b-256 9d238792cd8f2e62e70d4a423c505cdd3745be6a6608e07a0aee343de7a78cec

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