Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rundock.ai/llms.txt

Use this file to discover all available pages before exploring further.

Rundock runs locally. There is nothing to provision and no account to create. You install Claude Code, install Rundock, and open it. Pick the path that matches your machine:
  • Apple Silicon Mac → Path A
  • Windows 10 or 11 → Path B
  • Intel Mac, Linux, or building from source → Path C

​
Path A: Apple Silicon Mac

For Macs with M1 or later. The fastest route to a working Rundock.

​
1. Install Claude Code

Rundock relies on Claude Code to run agents. Claude Code is Anthropic’s command-line agent and it requires a Claude Pro or Max subscription. Follow the official guide at docs.anthropic.com/en/docs/claude-code/overview to install and authenticate.

​
2. Confirm Claude Code is working

Open Terminal and run: 
claude --version
You should see a version number. If you see “command not found”, Claude Code is not installed correctly. Go back to step 1.

​
3. Download Rundock

Get the latest .dmg from the releases page on GitHub: github.com/liamdarmody/rundock/releases The .dmg is signed for Apple Silicon. Intel Macs need Path C.

​
4. Install Rundock

Open the downloaded .dmg file and drag the Rundock icon to your Applications folder. Eject the .dmg once the copy completes.

​
5. Open Rundock

Open Rundock from Applications, Spotlight, or Launchpad. On first launch, macOS may show an unverified developer warning. To allow it:
  1. Open System Settings.
  2. Go to Privacy and Security.
  3. Scroll down to the Security section. You will see a note about Rundock being blocked.
  4. Click Open Anyway.
Rundock will open. Continue to first-run setup.

​
Path B: Windows (interim)

This path is interim and will be retired when the proper Windows installer ships. Until then, it is the recommended way to get Rundock onto a Windows machine without a real terminal session.
For Windows 10 or 11. A single PowerShell line installs everything Rundock needs.

​
1. Open PowerShell

Press the Windows key, type “PowerShell”, and open it. The standard PowerShell window is fine; you do not need to run as administrator.

​
2. Run the bootstrap

Paste this line and press Enter: 
irm https://raw.githubusercontent.com/liamdarmody/rundock/main/scripts/install-windows-source.ps1 | iex
The bootstrap takes care of five things end to end:
  • Checks for Node.js 20 or later and installs it via winget if missing.
  • Checks for Git and installs it via winget if missing.
  • Checks for Claude Code and prompts to run Anthropic’s installer if missing.
  • Clones Rundock to %USERPROFILE%\Rundock and runs npm install.
  • Creates a Desktop shortcut and a Start Menu entry pointing at a launcher script.
Re-running the bootstrap one-liner is safe at any time. It updates the existing checkout in place.

​
3. Open Rundock

Double-click the Rundock shortcut on your Desktop, or find Rundock in the Start Menu. The launcher boots the embedded server and opens your browser at http://localhost:3000 automatically. Continue to first-run setup.

​
Troubleshooting

If winget is missing on an older Windows 10 machine, install App Installer from the Microsoft Store first: 
ms-windows-store://pdp/?productid=9NBLGGH4NNS1
Then re-run the bootstrap one-liner. If you would prefer to install Claude Code yourself first, run Anthropic’s installer in PowerShell, then run the Rundock bootstrap: 
irm https://claude.ai/install.ps1 | iex
irm https://raw.githubusercontent.com/liamdarmody/rundock/main/scripts/install-windows-source.ps1 | iex

​
Path C: Build from source

For Intel Mac, Linux, or anyone who wants to run Rundock from source.

​
Requirements

  • Node.js 20 or later. Check with node --version.
  • Claude Code installed and authenticated. Confirm with claude --version.

​
Clone, install, and run

git clone https://github.com/liamdarmody/rundock.git
cd rundock
npm install
npm start
Open http://localhost:3000 in your browser. Rundock loads in the browser and behaves the same as the desktop app. The local setup path is also the contributor path. If you want to modify Rundock or contribute changes, this is the route to take. The Contributing section covers it in more depth.

​
Where to next

Whichever path you took, Rundock is now running.

First-run setup

What happens on first open and how to get to a working team.

Quick start

A working agent doing real work in under ten minutes.