yield CLI reference
Every command of yield 0.3.11, grouped by what you do with it. yield <command> --help prints the same on your computer, and every command that prints data takes --json.
Sign in and check
yield login
Signs in through your browser, registers this computer and installs and starts the capture service. The tonbo CLI shares the sign-in.
| Option | What it does |
|---|---|
--account <name> | Sign in to this organization instead of your personal account. |
--name <name> | This computer’s name the first time it is registered. |
--no-daemon | Only sign in; do not start capture on this computer. |
--device | Approve with a short code in a browser on any computer, as over SSH; chosen by itself over SSH without a display. |
yield status
The one health view: the sign-in, the connection to Tonbo, the capture service, each agent’s last captured activity, snapshots waiting to be sent, recent errors and whether a newer version is out. Each problem names its fix; it exits 1 when a check fails.
yield whoami
The account you are signed in to, your role and this computer’s device id.
yield devices
Your computers: each one’s name, whether it is online, when it was last seen, its system, its agents and its version of Yield.
yield logout
Revokes this computer’s keys and removes the saved sign-in.
Capture
yield daemon install
Runs capture as a login service (launchd on macOS, a systemd user service on Linux) and starts it, and writes the tonbo skill for your agents. yield login does this for you.
| Option | What it does |
|---|---|
--since <date> | On the first run, capture sessions changed since this date (default: 14 days). |
yield daemon status
Whether capture runs, its last upload, how many sessions it tracks and skipped, and its recent errors.
yield daemon uninstall
Stops the capture service and removes it, and the tonbo skill files it wrote that you did not change. What was captured stays.
yield daemon run
Captures in the foreground, logging to stderr, instead of as a service.
| Option | What it does |
|---|---|
--since <date> | As for yield daemon install. |
yield pause
Stops capture and snapshots on this computer until yield resume. Nothing written while paused is ever captured.
| Option | What it does |
|---|---|
--for <duration> | Resume by itself after this long: 30m, 2h, 1d. |
yield resume
Captures again after yield pause.
yield exclude [folder]
Never captures sessions in the folder, or anything under it, on this computer. Without a folder, lists the excluded ones.
yield include <folder>
Captures new sessions in a folder you excluded.
Projects
yield connect [folder]
Connects a folder (by default this git repository) to a Project: the Project of its git origin, made when there is none. In your personal account unless --account; with --account it says what the team will see and asks first.
| Option | What it does |
|---|---|
--account <name> | Share the folder with this organization’s team Project. |
--yes | Share without asking. |
--name <name> | The Project’s name when it is made; needed outside git unless --project. |
--project <id> | Join this Project of the account. |
yield disconnect [folder]
Removes the folder’s connection; the Project stays, and the folder’s new sessions stay in your personal account.
Sessions and recall
yield ps
What waits on you, each with the command that resolves it, then your sessions on every computer: state and since when, the computer, the agent, the repository and the files written lately.
| Option | What it does |
|---|---|
--all | Include ended sessions. |
--account <name> | Every member’s sessions in this organization’s team Projects, by metadata. |
--limit <sessions> | How many sessions, at most 100. |
yield context
For an agent at the start of a session, about 8 KiB: teammates’ live and recent work in this folder’s team Project (metadata only), your recent sessions and the handoffs you can see.
| Option | What it does |
|---|---|
--account <name> | This organization’s team Project instead of the folder’s. |
yield continue <description>
Finds your own earlier session by your description, on any computer or agent, lists the best three and picks up the first: its folder on the computer that captured it, otherwise its latest snapshot restored into a new directory. Prints its last turns.
| Option | What it does |
|---|---|
--pick <n> | Take the nth candidate instead of the first. |
--turns <n> | How many of its last turns to print (default: 3). |
--max-chars <n> | The longest message printed (default: 1200). |
--into <directory> | Where to restore it. |
--account <name> | Only your sessions in this organization’s team Projects. |
yield why <path>
Why a file is the way it is: the turns that changed it, newest first, with each turn’s prompt, the agent’s summary and the other files it changed.
| Option | What it does |
|---|---|
--limit <turns> | How many turns (default: 5). |
--max-chars <n> | The longest prompt or summary printed (default: 600). |
--account <name> | Every member’s turns in this organization’s team Project; from Yield 0.3.9 a teammate’s with its prompt and final reply, through the secret filter. |
yield files <path>
The turns that changed a file, newest first: when, the session and turn, the change, whether the session wrote the file itself, and the snapshot.
| Option | What it does |
|---|---|
--limit <turns> | How many turns. |
--account <name> | Every member’s turns in this organization’s team Project. |
yield session read <id>
Prints one of your sessions as user:, assistant: and tool: lines. The id may be the prefix yield ps shows.
| Option | What it does |
|---|---|
--turn <n> | Only this turn; 1 is the first. |
--max-chars <n> | The longest message printed (default: 2000). |
--account <name> | Your own session in this organization’s team Project. |
Handoff
yield
Hands off the live session of this folder’s Project: captures it up to now, pins a snapshot of the folder and prints a https://tonbo.dev/y/<id> link and whom it is for.
| Option | What it does |
|---|---|
--task <text> | What the next person or agent should do. |
--to <who> | A teammate in a team Project, by name; claude-code or codex for you in that agent; or <device>:<harness>, such as mac-2:codex, to run it unattended on another of your computers. By default, anyone the Project allows. |
--session <id> | Which session, when more than one is live here. |
--recover | After a lost answer, retry the same snapshot. |
--new | Start another handoff of the session with a fresh snapshot. |
yield give <session>
Hands off a captured session by its full id, from its latest captured snapshot.
| Option | What it does |
|---|---|
--task <text> | What the next person or agent should do; required. |
--to <who> | As for yield. |
yield take <link>
Restores a handoff’s snapshot into a new directory beside this repository, never changing the original, and prints its task, files and recent turns.
| Option | What it does |
|---|---|
--into <directory> | Where to restore it. |
--account <name> | The organization that holds it; by default each one this computer is signed in to is tried. |
yield done <result>
In a restored directory: publishes the result and records the handoff done, for its author to yield pull.
| Option | What it does |
|---|---|
--result <text> | The result, when the first argument is a handoff link. |
yield need-human <why>
In a restored directory: records that the work waits on a person’s decision.
yield pull <link>
Fetches the latest result of a handoff, or of a session by its id, onto a new branch, without changing your files.
| Option | What it does |
|---|---|
--patch | Write a patch file instead of a branch. |
--account <name> | The organization that holds it. |
yield show <link>
A handoff’s state, author, whom it is for and who took it, without taking it.
| Option | What it does |
|---|---|
--account <name> | The organization that holds it. |
yield handoffs
Your open handoffs, the ones you gave, hold or are named in, across your personal account and every organization.
| Option | What it does |
|---|---|
--account <name> | Only this organization’s. |
yield events
What happened to your handoffs after a cursor (created, taken, finished, needs a human, cancelled), with a Next: cursor for the next read.
| Option | What it does |
|---|---|
--after <seq> | The last event already seen (default: 0). |
--wait <seconds> | Hold up to this long, at most 25 seconds, for a first event. |
--account <name> | Only this organization’s. |
yield renew <link>
Keeps a handoff’s snapshot 30 more days.
| Option | What it does |
|---|---|
--result | Renew the finished result’s snapshot instead. |
--account <name> | The organization that holds it. |
yield cancel <link>
Withdraws a handoff you gave before anyone takes it.
| Option | What it does |
|---|---|
--account <name> | The organization that holds it. |
Inbox
yield inbox list
Unread messages on this computer: a handoff that names you or is open to your team, one you gave being taken, finished, failed, returned or waiting on you, and two of your sessions writing the same file, here or in the same Project on another of your computers. yield inbox alone does the same.
| Option | What it does |
|---|---|
--all | Include read and ignored messages. |
--new | Only messages no session has seen yet, then marks them seen: for an agent without hooks, such as Codex. |
yield inbox ack [ids...]
Marks messages read; without ids, every unread one.
yield inbox ignore <ids...>
Sets messages aside.
yield inbox rate <id> <rating>
Records whether a message was useful or noise.
yield inbox mute
Stops system notifications; messages still reach the inbox.
yield inbox unmute
Raises system notifications again.
Alpha
yield note
Records that another session’s work changed your plan, as a content-free measure; never why.
| Option | What it does |
|---|---|
--changed-plan <session> | The full id of that session. |