Skip to content
pertmux

Quick Start

1. Get a token

Section titled “1. Get a token”

You need a personal access token from your forge:

  • GitHub: GitHub Setup — create a classic PAT with repo scope
  • GitLab: GitLab Setup — create a token with read_api scope

2. Create a config file

Section titled “2. Create a config file”

Create ~/.config/pertmux.toml:

[github]
token = "ghp_your-token-here"


[[project]]
name = "My Project"
source = "github"
project = "org/my-repo"
local_path = "/home/user/repos/my-repo"
username = "youruser"

See Config Reference for all available options.

3. Start the daemon

Section titled “3. Start the daemon”
Terminal window
pertmux serve

The daemon backgrounds itself automatically, polling your forge for MR/PR updates on tiered intervals.

4. Connect the TUI

Section titled “4. Connect the TUI”
Terminal window
pertmux connect

You should see your open MRs/PRs, linked worktrees, and any active coding agents.

Next steps

Section titled “Next steps”