Agent setup

Install the official arbitr CLI, connect an API key, and verify the setup with any coding agent that can run terminal commands.

Quick setup

Already have a coding agent? Paste this prompt:

Set up arbitr for me. Fetch https://arbitr.apidocumentation.com/getting-started/agent-setup/index.md and follow it.

The agent installs the CLI, pauses while you create and store a key, verifies access, and installs persistent arbitr guidance. It will not submit a translation project.

For manual installation and usage, see CLI.

Agent instructions

If you fetched this page because a user asked you to set up arbitr, continue below. Do not fetch this page again.

How to run

Run the terminal steps yourself. Pause only while the user creates and stores an API key. Never ask them to paste the key into chat, and do not create a translation project until they ask.

Python 3.11 or newer is required. Default API host is https://api-arbitr.straker.ai.

1. Install the CLI

Check for an existing install:

python3 --version
arbitr --help

If arbitr is missing, install from PyPI:

pip install arbitr-sdk
arbitr --help

uv tool install arbitr-sdk is fine if the user already uses uv. Confirm the command is on PATH. The PyPI package is arbitr-sdk; the command and import stay arbitr.

2. API key

The API cannot mint a key. Pause and send the user here:

https://arbitr.straker.ai/settings/api-keys

They need Create an API key. For later submit and download, the key must include both verify:submit and verify:read.

Prefer a test key (abr_test_…) for first-time wiring — it does not run the pipeline or spend credits. Read Test mode before using a live key (abr_live_…).

Ask the user to store the plaintext locally without sharing it in chat, either in the environment or in .env in the current project:

ARBITR_API_KEY=abr_live_…

arbitr_api_key= in the same file also works. Optional ARBITR_BASE_URL overrides the default host. Before using .env in a Git repository, confirm it is ignored. Never pass the key as a CLI flag, echo it, log it, or overwrite unrelated .env values.

3. Verify

arbitr me

Expect JSON with org_id, mode (live or test), and scopes. If a required scope is missing, they must revoke and mint a new key.

A missing key exits 2 and points at the mint URL. Do not retry me until .env (or the environment) actually contains the key.

4. Install guidance

Install the Agent skill once for this agent so later sessions keep locale, key, and wait rules without re-fetching this playbook. Skip this section if npx is unavailable.

npx -y skills add strakergroup/arbitr-python --skill arbitr --yes --global

Confirm the skill is listed (npx skills list). If install fails, fetch the raw skill and follow it for this session. Reload the agent if the installed skill does not appear.

Completion

Report only verified state:

arbitr CLI setup is ready
CLI: <version or `arbitr --help` ok>
Key: <live|test|not set>
me: <org_id, mode, scopes | failed>
Guidance: <skill installed globally | skipped (no npx)>
Project submit: not run (wait until the user asks)

When they later ask to submit, run arbitr submit --help and use lowercase BCP-47 tags (ko-kr, fr-fr).

If they want MCP tools as well, fetch MCP as markdown and follow it. Do not add MCP during this CLI setup.

CLI

Agent skill