# Yardsort documentation **New here?** Start with the [quick start](quick-start.md) — from download to your first agent in a few minutes. ## Using Yardsort For supported agents, platforms, costs, worktree isolation and data handling, read [About Yardsort](guide/questions.md). To compare agent tokens and estimated API costs, or find which workspace is using CPU and memory, open **Usage** from the sidebar or command palette. The [Usage guide](guide/usage.md) walks through both tabs and explains what the local figures include. | Guide | What it covers | | ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Quick start](quick-start.md) | Install, add a project, start your first workspace | | [Migrate from Conductor](guide/migrate-from-conductor.md) | Import existing local worktrees, reconfigure scripts by hand, and see what is not imported | | [Projects](guide/projects.md) | Adding, creating, reordering and removing projects; the `local` workspace | | [Workspaces](guide/workspaces.md) | The composer, branches and worktrees, rename / archive / restore / delete | | [Terminals & sessions](guide/terminals-and-sessions.md) | Tabs, shells, status dots, notifications, resume and fork, handing work on, what agents can read of each other | | [Changes & files](guide/changes-and-files.md) | Reviewing what an agent did: changed files and who wrote them, diffs, the file tree | | [Commits & pull requests](guide/commits-and-pull-requests.md) | Committing, pushing and opening a pull request; check results on a row | | [Pull requests](guide/pull-requests.md) | Every project's pull requests in one view: filter them, start a workspace on one, merge, close | | [Tasks](guide/tasks.md) | Every project's GitHub issues in one view: which need an answer, what was said; `ys task` too | | [Settings & harnesses](guide/settings.md) | Configuring agents, adding your own, worktree folder, editor | | [Assist](guide/assist.md) | Optional AI checks on changed files and suggestions in the composer | | [Activity](guide/activity.md) | The local record of what ran, what each agent reports, and the experimental timeline | | [Memory](guide/memory.md) | Lessons about a project for its agents, approved by you; the switch for sharing conversations between them | | [Outcomes](guide/outcomes.md) | What became of each attempt, and each agent's history on your work | | [Workflows](guide/workflows.md) | Named, reusable agent work in YAML: the built-in code review, writing and checking your own | | [Smoke tests](guide/smoke-tests.md) | A test file in your repository an agent writes and Yardsort runs: browser steps, approval, the Tests view, `ys test` | | [Schedules](guide/schedules.md) | Run a workflow or a smoke test once at a set time, or on a routine, while Yardsort is open; `ys schedule` too | | [Triggers](guide/triggers.md) | Start a workflow or a smoke test when an agent says it is done, a review comes in, the checks fail, a run ends or a custom event is raised; the Triggers view, the composer's presets, `ys trigger`, `ys event emit` | | [Notifications](guide/notifications.md) | One list of what needs you and what finished while you were not looking: an agent that asks for a permission, finishes or stops with an error, across every project; filters, grouping, and what Yardsort can know | | [Floor Manager](guide/floor-manager.md) | One agent that sees every project. A setting chooses read only, ask first or trusted, and `ys` enforces it | | [Remote](guide/remote.md) | Reaching this computer from your phone or another computer through a server, and syncing a project between your computers. Still under development, and off until you turn it on | | [The phone app](guide/phone.md) | What the phone app does, what it needs, and where to get it: invite only for now, in the app stores in a few weeks | | [Deleting your account](guide/delete-account.md) | What deleting your Remote account removes from the server and what stays on your devices, and how: on a computer, on the phone or on the server's web page | | [A computer with no screen](guide/headless-host.md) | `yardsort-host`: a Linux server as a host your phone reaches; signing in, pairing at a terminal, `ys` for projects | | [The host dashboard](guide/host-dashboard.md) | A web page a host serves to itself, for setting it up from a browser: agents, Git and GitHub, setup commands; signing in, the tunnel, turning it off | | [Usage](guide/usage.md) | Tokens your agents spent and what they would cost; CPU and memory per agent, live | | [Updates](guide/updates.md) | How Yardsort finds and installs new versions, and which copies can | | [Keyboard shortcuts](guide/shortcuts.md) | Every shortcut, and why they look the way they do | | [The `ys` command line](guide/cli.md) | Installing it; starting, deleting and handing off workspaces from a terminal or a script | | [Troubleshooting](guide/troubleshooting.md) | "Command not found", blank windows, where your data lives | ## Tutorials and articles Follow the [parallel Claude Code and Codex tutorial](https://www.yardsort.sh/tutorials/claude-code-codex-parallel-worktrees/) for a complete two-task example. The [blog](https://www.yardsort.sh/blog/) covers product decisions, worktree tradeoffs, and comparisons with Superset and Conductor. ## Getting help - Something broken or missing? [Open an issue](https://github.com/joaoh82/yardsort/issues/new/choose) — see [Troubleshooting](guide/troubleshooting.md) first for the common ones. - Anything else — a question, help getting started, a word about what you are building — write to **[hello@yardsort.sh](mailto:hello@yardsort.sh)**. - Found a vulnerability? Report it privately: [SECURITY.md](../SECURITY.md). ## Building and contributing - [CONTRIBUTING.md](../CONTRIBUTING.md) — set up a dev environment, run the checks, send a change - [A test box for Remote](test-box.md) — a throwaway Linux server on Hetzner Cloud for trying the headless host with your phone - [Releasing](releasing.md) — how versions are cut and what the release workflow does - [Design docs](design/README.md) — vision, architecture, harness model, roadmap, open questions