Files
treg/docs/ONBOARDING.md
T
Jason ZhouandClaude Fable 5 8ca54c0c6f feat: treg.to is the canonical domain — treg.superdesign.dev becomes the legacy alias
public_url/email_from defaults, render.yaml, CLI fallbacks, packaging (npm/plugin/pyproject),
web pages (+canonical tag), docs and context fragments all move to https://treg.to.

The legacy host keeps serving the FULL API forever — installed CLIs, skill.md files and
.mcp.json configs in the wild hold Bearer tokens pointed at it, and HTTP clients strip
Authorization on cross-host redirects. Only browser-facing marketing pages 301 to treg.to
(new middleware + tests).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-08-13 11:56:20 +10:00

2.1 KiB

tools-registry — onboarding

The bootstrap an agent (or human) follows to start calling shared tools and to share its own. The CLI is a thin client over the API at https://treg.to; the API is the only brain.

1. Install the CLI

curl -fsSL https://treg.to/install.sh | sh   # installs `treg`, points it at the registry

(Working from a clone instead? uv sync && uv run treg --help.)

2. Sign in

Three doors, one identity (your email):

treg login                                  # GitHub OAuth (opens the browser)
treg login --email you@example.com          # email one-time code
treg login --token <TOKEN>                  # agents/CI: a per-org token from a team owner

Your token identifies you on every call (X-Treg-Token). New here? treg onboard walks you through everything with a disposable demo team.

3a. Use a tool someone already shared (consumer)

treg tool ls                                 # what's available
treg call posthog query/events --query limit=5
treg run gh -- pr list                       # vendor CLIs work too

You hold no upstream key — the registry injects it server-side.

3b. Share your own (creator)

Point treg at a project — it finds the provider keys in the .env, the skill folders, and the installed catalog CLIs, and registers what you pick:

treg scan          # read-only preview; nothing leaves the machine
treg upload        # register (encrypted server-side); idempotent, --replace to update

For one skill or a tricky tool (multi-credential, OAuth), see the manual flow in USAGE.md — treg skill init / skill add, treg tool add --bind, treg oauth connect.

4. Verify + observe

treg call <tool> <upstream-path>     # smoke-test
treg calls                           # audit: who called which tool, when, status
treg health                          # credential health across the org

Notes

  • Secrets are write-only; the API never returns a stored value.
  • A tool can reference a secret another member uploaded (use-without-hold).
  • Everything is org-scoped: treg org ls / treg org use <slug> picks the active team.