Install Tarmac

Tarmac is free and open source (MIT). It runs on your machine, opens in your browser and installs as an app (PWA). Prefer a double-click installer with automatic updates? That is Tarmac Pro.

Requirements

  • macOS (Apple silicon or Intel), or Windows 10/11 with WSL 2.
  • Node.js 22.13 or later.
  • Optional: the GitHub CLI (gh), Docker Desktop, OrbStack or Colima (Docker view, local Supabase), Claude Code and/or Codex (agent sessions and Todolist).

macOS

npm install -g @codustel/tarmac
tarmac setup

tarmac setup installs a login service, then, with your confirmation, makes http://tarmac.localhost work and offers to set up the Claude Code integration. Run tarmac setup --dry-run first to see every action without changing anything; --no-sudo skips the optional steps that need your password.

The address that always works is http://tarmac.localhost:7777.

Windows (WSL 2)

On Windows, the free version of Tarmac runs inside WSL 2 and is started by hand. The dashboard, project detection, ports and live logs, consoles, the Git menu, GitHub, local Supabase and the Todolist all work.

  1. In PowerShell, install Ubuntu:

    wsl --install -d Ubuntu
  2. In the Ubuntu terminal, install the tools, then Node.js 22.13 or later (for example nvm install 22) and pnpm (corepack enable):

    sudo apt update && sudo apt install -y git lsof build-essential python3
  3. Get Tarmac and start it:

    git clone https://github.com/codustel/tarmac.git ~/tarmac
    cd ~/tarmac
    pnpm install
    pnpm build
    DEV_ROOTS=~/dev node dist/server/index.js
  4. Open http://localhost:7777 in Edge or Chrome. DEV_ROOTS lists the folders to scan; you can change them later in Settings.

Rather have a native app with automatic updates? See Tarmac Pro.

First steps

  1. Open Tarmac (tarmac open on macOS) and click Install the app to get a Dock or taskbar icon.
  2. In Settings, check the folders to scan, then connect the GitHub CLI in one click.
  3. Start an app with Start, open its console, or open an agent session from its Claude or Codex tab (tick Codex in Settings → Agents first).
  4. Type /suivi init in a Claude Code session, or $suivi init in a Codex session, to create the project’s Todolist.

Useful commands (macOS)

tarmac status | start | stop | restart | logs | open
tarmac doctor     # checks Node, the service, the port, the domain, gh, Docker and Claude Code
tarmac update     # installs the latest version, then restarts

On Windows, update with git pull && pnpm install && pnpm build, then start Tarmac again.

Uninstall

tarmac uninstall            # service, address set-up, MCP server in Claude Code
tarmac uninstall --purge    # the same, and deletes ~/.tarmac
npm uninstall -g @codustel/tarmac

Need help?

Run tarmac doctor, read the troubleshooting guide in the GitHub repository, or open an issue there.