Skip to content

agent-onboarding.mdx

Latest commit

 

History

History
110 lines (71 loc) · 2.54 KB

agent-onboarding.mdx

File metadata and controls

110 lines (71 loc) · 2.54 KB
Raw

Onboard an agent to Tilebox

You are setting up Tilebox for a coding agent that can run terminal commands and edit code, such as Amp, Codex, Claude Code, or Cursor.

If you are using ChatGPT or claude.ai, stop. Tell the user to switch to Codex or Claude Code. Do not suggest MCP.

Goal

Get the agent ready to use Tilebox from the terminal:

  1. Install the Tilebox CLI and Agent Skills.
  2. Help the user create an API key.
  3. Give the user the exact shell command to set TILEBOX_API_KEY and reload their current environment.
  4. Verify read-only setup. Do not change Tilebox resources.

Step 1: install the Tilebox CLI and Agent Skills

Run:

curl -fsSL https://install.tilebox.com/wizard.sh | sh

Then verify:

tilebox --help
tilebox agent-context

If tilebox is not on PATH, use the default installed path directly:

$HOME/.local/bin/tilebox --help

Confirm the Tilebox skills are present in the user's skills directory.

Step 2: ask the user for an API key

Send the user here:

https://console.tilebox.com/settings/api-keys

Ask them to create a key with the smallest permissions needed for their task.

Do not ask them to paste the key into chat unless there is no safer option. Prefer that they run a command in their own terminal.

Step 3: give the exact command for their shell

Detect the user's shell with:

basename "$SHELL"

Then give them one of these commands, replacing YOUR_TILEBOX_API_KEY with their key.

zsh

echo 'export TILEBOX_API_KEY="YOUR_TILEBOX_API_KEY"' >> ~/.zshrc && source ~/.zshrc

bash

echo 'export TILEBOX_API_KEY="YOUR_TILEBOX_API_KEY"' >> ~/.bashrc && source ~/.bashrc

If they use macOS bash login shells, use:

echo 'export TILEBOX_API_KEY="YOUR_TILEBOX_API_KEY"' >> ~/.bash_profile && source ~/.bash_profile

fish

set -Ux TILEBOX_API_KEY "YOUR_TILEBOX_API_KEY"

Fish universal variables apply to new shells automatically. For the current shell, also run:

set -gx TILEBOX_API_KEY "YOUR_TILEBOX_API_KEY"

Step 4: verify safely

Run read-only checks only:

tilebox agent-context
tilebox dataset list --json

Confirm:

  • CLI installed
  • skills installed
  • TILEBOX_API_KEY is available without printing it
  • tilebox agent-context works
  • datasets can be listed

Do not create, update, delete, submit, retry, cancel, deploy, or undeploy anything unless the user explicitly asks.

Keep the response short. Tell the user what is done, what they need to do next, and the one command they should run.