Quick start

Splitterm starts with the desktop app, a tiling terminal that is free forever. It is Windows-first today, and macOS and Linux are in progress. You need a Splitterm account to download it.

See Install and first run for the details.

1. 1Press the account button at the right end of the top bar, or open Settings > Account (Ctrl+,), and choose to sign in.
2. 2Press Continue in browser. Your browser opens a page that asks: Link Splitterm on this machine?
3. 3Check that the code in the browser matches the pairing code in the app, then press Approve.
4. 4The app finishes signing in. You can revoke it at any time under Account sessions.

Splitterm never sees your password: signing in happens in your browser. The terminal works signed out too, on the Free plan.

1. 1Press Add a project under your projects in the sidebar, or run Add a project from the command palette (Ctrl+Shift+P).
2. 2Pick the folder you work in. A repository becomes the project's first repository.
3. 3A folder that is not a repository itself but holds several side by side is shown first, with every repository inside it. Switch off any you do not want and press Add the project: the project gets them all in one step.

The project opens on its Terminals view, with a choice of what to open: Claude, a shell or one of your profiles. See Projects and repositories.

1. 1At the foot of the sidebar, the This machine card says Runner not set up. Press Set up.
2. 2Splitterm checks that Claude Code is installed and signed in, and that git is there. The GitHub CLI is optional.
3. 3Give the machine a name you will recognise, choose when runs start, and run the one-minute test run, or skip it.
4. 4Press Finish setup. The runner is on.

Runs use the Claude Code that is installed and signed in on this machine. See The Runner.

1. 1Open the project's Issues and press New issue. Give it a title and, if it helps, a description of what done looks like. Press Create.
2. 2Open the issue. Under Run it on a machine, choose this machine and press its Dispatch button.
3. 3The agent works in a copy of the repository, on a branch of its own. When it is done it presents its work, and the issue moves to In review.
4. 4Read the review, then press Approve and confirm. The agent wraps up and gets the pull request ready.

A question or a permission ask from the agent waits in Needs you, the bell in the top bar. See Issues and notes.

When the cloud service is live, a machine you link from the desktop shows up under Devices. On Pro, link it from This machine, under Work from anywhere. Linking always starts from the desktop, so the browser never holds a machine's credentials.

1. 1Create a project from the dashboard.
2. 2Open the project's Settings and find GitHub. Only project owners can connect it.
3. 3Choose how much access to grant, then press Connect GitHub.
4. 4On GitHub, pick the repositories the project works on and install. You land back on the project's settings.

This is separate from signing in with GitHub, which is only a login and grants no repository access.

In the dashboard you and your teammates file, order and review a project's issues in the browser. Starting a run still happens in the desktop app on your machine. See Dispatching agents.

• You are signed in on the desktop.
• Your project has its repositories.
• The runner is on.
• Your first issue is in review, or done.

Devices, GitHub and the dashboard depend on the cloud service, which is in preview. Everything in the checklist works in the desktop app today.