Get Started

Getting Started: Install & Run Your First Team

Download Munk AI, connect your models, and run your first coding work item or standing project shift by importing a template or linking a local repo.

Get your agent team up and running on your computer in just a few steps.

1. Download and Install

Grab the installer for your platform from the Install page:

  • macOS: Apple Silicon (M1–M4) and Intel (.dmg)
  • Windows: x64 and ARM64 (.exe)
  • Linux: x86_64 and ARM64 (.AppImage)
  • Android (Optional): Install the Mobile Host (.apk) to scan QR codes for mobile previews and approve gates from your phone

Launch Munk AI after installation. The local host and built-in agent runtime start automatically.

2. Configure Your AI Models

Open Settings → AI to connect the models your agents will use. You have two options:

  1. Zero-Config Official Models: Sign in with your Munk account to use ready-to-go models out of the box.
  2. Bring Your Own Key (BYOK): Connect any OpenAI- or Anthropic-compatible provider (OpenRouter, OpenAI, DeepSeek, etc.) by entering your Base URL, API Key, and Default Model, then click Save.

Settings · AI

3. Choose How to Start

From the Munk AI home screen, pick the starting path that fits your goal:

Munk AI Home

The fastest way to see a multi-agent team in action is to import an official template:

  1. Visit opencompany.run, pick a template (such as Open-Source Software Team), and click Import into Munk AI—or copy the template URL and paste it into Import Company inside the desktop app.
  2. Review Before Writing: Munk AI previews every product, task (tasks/*.md), and preflight script (guards/*.mjs) in the package before writing anything to disk. No hardcoded secrets are ever included.
  3. Safe by Default: Once imported, all scheduled shifts stay Paused by default. Nothing runs or spends tokens until you turn a schedule on or trigger a shift manually.

Option B: Attach Your Own Codebase

If you want agents to work on your own repository right away:

  • New Project: Scaffold a fresh local repository with an out-of-the-box development environment.
  • Open Local / Clone Repo: Attach an existing local Git directory or clone an authorized GitHub repository as a Codebase.

4. Run Your First Workflow

Once inside a product workspace, try either track:

Run a Coding Work Item (Code)

  1. Create a new Work Item in the Workbench and describe a feature or bug fix in plain language.
  2. Chat briefly with the Intake Agent in the center panel to lock in scope (it writes prd.md and hands off).
  3. Watch the Workflow panel advance through Coding and Code Gates. Once all checks pass and the run pauses at the delivery gate, click to approve the local merge.

Run a Project Shift (Projects)

  1. Switch to the Projects view and open a project (for example, github triage or daily-patrol).
  2. Select any task and click Run Shift Now (or toggle its schedule on).
  3. Follow the live agent session as it executes the shift and writes back a structured summary.

Next Steps