Getting Started

Quick Start

Go from a fresh install to a branch running in a workspace of its own in three commands, or paste one prompt into your coding agent.

By the end of this page, you'll have a branch of your project running in a workspace of its own, and your machine clean again. It takes three commands, and it's the loop you'll use for every pull request you review.

Before you start

You'll need two things:

  • Testlane, installed so that testlane version runs.
  • A git repository you can clone, with a dev script and a branch to try. We'll call the project my-project and the branch feat/login.

Run your first workspace

Add your project

testlane setup --name my-project --repo git@github.com:my-org/my-project.git --detect

setup clones the repository and drafts the project's config from its own files, like its lockfile and its dev script, so you don't write any TOML. Press Enter to keep each default it offers, and if it shows you a .testlane.toml from your repository, read the commands in it before you answer y to trust them.

Run a branch

testlane my-project feat/login run dev

run makes a workspace for the branch, installs its dependencies and starts its dev server on a port of the workspace's own, so it never collides with your own checkout. Press Ctrl-C to stop it.

Clean up

testlane my-project feat/login rm

rm removes the workspace once you answer y, and keeps the clone, so your next branch only needs a fetch.

That's the whole loop. Review a pull request runs it on a pull request, and How it works explains what each command did.

Or hand it to your agent

If you work with a coding agent, like Claude Code, Codex or Cursor, it can set Testlane up for you. Paste this prompt into it, and it installs Testlane, learns the commands and adds your repository as a project, asking you before it trusts anything:

Set up Testlane, a CLI that runs any branch or pull request of my project in a workspace of its own, so you can run and check changes for me.

1. Install it with `npm i -g @uxfront/testlane`, then check that `testlane version` prints a version.
2. Read https://testlane.dev/raw/docs/getting-started/agents.md and follow its agent instructions from now on.
3. Add my repository as a project: `testlane setup --name <project> --repo <clone URL> --detect`, with its origin URL and a short lowercase name. Don't pass `--yes`.
4. If setup says the repository's `.testlane.toml` is not trusted, show me the commands it printed and ask me. Only if I agree, run `testlane config trust <project> --yes`.
5. If setup drafted a config, show me each line marked `# guess:` or `# note:`, so I can check it.

Agents explains what the prompt does, and how to give your agent Testlane's instructions or its MCP server instead.

Copyright © 2026