All Documentation

Documentation Building on your machine

What the room is allowed to do

Six modes, from read-only to unattended, and the approvals in between.

You decide how much the room may do without asking. The mode is a chip beside the composer.

  • Manual: asks before every file change and every command. For a tree you are nervous about.
  • Accept edits: file changes go through; commands ask.
  • Smart: file changes go through, and a fast model looks at each command and either allows it or hands the question to you. Anything short of a clear yes asks. It never allows a dangerous command, and it never allows anything when nobody is there to ask.
  • Plan: read and think, change nothing. The room investigates, agrees a plan, and hands it to you.
  • Auto: works, and asks only about the dangerous things. The default.
  • Bypass: never asks. The sandbox still applies. For a throwaway checkout, not for your main tree.

Approvals

When the room wants to do something the mode does not cover, it asks — and the question reaches wherever you are. An approval raised on your Mac appears on your phone and in the browser too, so a run started at your desk does not sit blocked while you are out.

What it asks about depends on the mode: a command the rules do not already allow, a write outside the workspace if you chose to be asked, a host the sandbox refused, and a few things it always asks about, such as protected instruction files, merges, schedules and mail. A command card offers Allow, Always (remembered for this project) and Deny; a sandbox card offers Allow for this discussion, Always allow and Deny. On the web and the phone, cards offer Allow and Deny.

The sandbox

Commands run inside a sandbox where the platform supports one, confined to the workspace. When something needs out, you are asked rather than quietly allowed.

Rules you set once

Commands you always allow — your test runner, your linter — can be remembered per folder, so the same approval is not asked twice a day. They are stored with the folder, not globally, because make deploy means different things in different repositories.

See Also

Not what you were looking for? The help centre answers one question at a time, and the support page says how to reach a person.