DocsOverview

Requirements

Plexus drives the Claude Code CLI on top of Git, so both must be on your machine — a couple of optional tools unlock the rest.

Claude Code CLI

Plexus runs every session through the Claude Code CLI; it does not bundle its own agent. Install Claude Code and confirm the claude command works in a terminal:

bash
claude --help

Plexus finds claude on your PATH at startup, so a standard install needs no configuration. There's no API key to enter — your existing Claude Code authentication is handed through to each session.

If Plexus can't find claude, set an explicit path in Settings → Agent → Claude program path (the agent.programPath setting) and point it at the actual executable. This is common on Windows, where Claude Code installs as an npm shim (claude.cmd) or through Volta and isn't on the PATH Plexus sees — for example C:\Users\me\AppData\Roaming\npm\claude.cmd.

See Settings for where this lives.

Git

Git must be installed and on your PATH. Plexus uses it to detect repositories, create and remove worktrees, switch branches, and compute diffs. Any standard Git install satisfies this.

Git providers (for pull requests)

Pull-request features — opening PRs, reading status, and checking CI — need a connected git provider, either GitHub or Bitbucket. There's nothing to install: open Settings → Git providers and click Connect, then approve the one-click sign-in in your browser. The gh CLI is not required. Everything else (sessions, editing, local Git) works without connecting. See Connections.

notify-send (Linux, optional)

On Linux, Plexus uses notify-send for native desktop notifications — for instance when an agent needs your input. Without it, Plexus falls back to its in-app notifications, so it's purely optional. macOS and Windows use their native notification systems and need nothing extra.

Supported platforms

OSArchitecturesNotes
macOSApple Silicon (aarch64), Intel (x86_64)Native builds for both
Linuxx86_64AppImage and .deb; notify-send optional
Windowsx86_64NSIS -setup.exe installer; npm/Volta shims supported via agent.programPath

Ready to get it running? See Install.