# spin agent

**Spinbox is experimental: APIs change and data may be lost.** What is built and what proves it is on [Status](https://docs.spinbox.dev/reference/status.md); what Spinbox does not do is on [Limitations](https://docs.spinbox.dev/overview/limitations.md).

> spin agent: Run T3 Code in a workspace and use it from this computer.

<!-- Generated by tools/refgen from spin:cmd/cli. Edit the source, not this file. -->

```
Run T3 Code in a workspace, on the repository at path, and use its web UI from this computer.

T3 Code is the server that drives Claude Code and Codex from a browser: threads, checkpoints,
and switching between them. The workspace's supervisor runs it on demand - the same server the
dashboard's Agent tab opens - as the workspace's agent user, spin-agent-t3: no capability, its
egress brokered and marked, given only path. It listens on the workspace's loopback alone, and
your own SSH session forwards it here, so the UI is at http://127.0.0.1:3773 and
the link printed pairs your browser with it. Closing the session, with Ctrl-C, ends the
forwarding; the server goes on for half an hour with nothing asked of it and no chat running,
then stops, and its threads stay in the agent's home on the disk.

path defaults to the project's checkout, /workspace/<repository>, and to /workspace in a
workspace with no project.
T3 Code's server is a Node program that needs a workspace of 2048 MB or more; the
supervisor refuses to start it below that and says how to give the workspace more.

Examples:
  spin agent my-workspace
  spin agent my-workspace /workspace/app --start
  spin agent my-workspace --port 4000

Usage:
  spin agent <workspace> [path] [flags]
  spin agent [command]

Available Commands:
  home        The agent's homes: volumes that outlive their workspaces

Flags:
  -h, --help[=true|false]    help for agent
  -i, --identity string      Identity file (private key)
      --port int             The port on this computer the session forwards T3 Code to (default 3773)
      --start[=true|false]   Start the workspace first if it is stopped
      --timeout duration     How long to wait for the workspace to be running; by default, until the control plane gives up on it

Global Flags:
      --config string        config file (default is $HOME/.spin/config.yaml)
  -o, --output string        text for a person, or json: one document of what the API answered, and no prose (default "text")
      --profile string       named profile to use; SPIN_PROFILE names it when this flag does not (default "default")
      --traceparent string   the W3C traceparent of the span this command is part of; its own span is sent to the installation unless the profile says telemetry: false

Use "spin agent [command] --help" for more information about a command.
```

### spin agent home

```
An agent's home is a volume of its own, mounted at /home/spin-agent-t3 in the workspace: what
T3 Code and Claude Code keep there - the chats - outlives the workspace. Erasing a workspace
leaves its home yours, unmounted; a new workspace mounts it at its creation (spin workspace
create --agent-home <id>) and finds the chats there.

Usage:
  spin agent home [flags]
  spin agent home [command]

Available Commands:
  delete      Erase an agent home no workspace mounts: its chats, its key and its bytes
  list        Your agent homes, and which workspace mounts each

Flags:
  -h, --help[=true|false]   help for home

Global Flags:
      --config string        config file (default is $HOME/.spin/config.yaml)
  -o, --output string        text for a person, or json: one document of what the API answered, and no prose (default "text")
      --profile string       named profile to use; SPIN_PROFILE names it when this flag does not (default "default")
      --traceparent string   the W3C traceparent of the span this command is part of; its own span is sent to the installation unless the profile says telemetry: false

Use "spin agent home [command] --help" for more information about a command.
```

#### spin agent home delete

```
Erase an agent home no workspace mounts: its chats, its key and its bytes

Usage:
  spin agent home delete <id> [flags]

Flags:
  -h, --help[=true|false]   help for delete

Global Flags:
      --config string        config file (default is $HOME/.spin/config.yaml)
  -o, --output string        text for a person, or json: one document of what the API answered, and no prose (default "text")
      --profile string       named profile to use; SPIN_PROFILE names it when this flag does not (default "default")
      --traceparent string   the W3C traceparent of the span this command is part of; its own span is sent to the installation unless the profile says telemetry: false
```

#### spin agent home list

```
Your agent homes, and which workspace mounts each

Usage:
  spin agent home list [flags]

Flags:
  -h, --help[=true|false]   help for list

Global Flags:
      --config string        config file (default is $HOME/.spin/config.yaml)
  -o, --output string        text for a person, or json: one document of what the API answered, and no prose (default "text")
      --profile string       named profile to use; SPIN_PROFILE names it when this flag does not (default "default")
      --traceparent string   the W3C traceparent of the span this command is part of; its own span is sent to the installation unless the profile says telemetry: false
```
