Getting started
Install#
Modular is a desktop app for macOS, Windows and Linux. Builds are published on the releases page (the repository is private: you need access to download).
| Platform | Package | Updates |
|---|---|---|
| macOS | .dmg | Sparkle, in the app |
| Windows | installer (.exe) or .zip | in the app |
| Linux | AppImage, .deb, .rpm | in the app (AppImage) |
To run Modular from a clone instead, see Development.
First start#
The app opens on a welcome screen, then asks for two optional things:
- A model provider: an API key or a compatible endpoint, for the parts of Modular that call a model directly. Agent CLIs such as Claude Code and Codex log in on their own and do not need it.
- GitHub, through the Modular GitHub App, for pull requests, checks and Review code in the Git studio.
You can skip both and set them up later in Settings.
Add a project#
A project is a folder on your machine (or several folders opened together). In the left rail, click Add project and pick the folder. Each project has its own Spaces: boards where its terminals, agents and notes live.
Open a terminal and an agent#
Press ⌘T (Ctrl+T on Windows and Linux) or click New in the toolbar:
- Shell opens a terminal in the project folder.
- An agent (Claude Code, Codex, or any agent you set up in Settings → AI → Agents) opens the agent CLI in a terminal. Claude Code and Codex ask for an optional first message; Esc starts the agent without one.
- Kanban puts the project's board on the Space; Browser opens a web page.
Click a terminal to bring it to 100% and type into it. Double-click its header for focus mode; Esc leaves it.
Modular finds agent CLIs installed on your PATH (Claude Code, Codex, Gemini and
others) and offers them as agents. The Claude Code preset starts claude with
--dangerously-skip-permissions: it runs without asking before each action. Edit
the agent's command in Settings → AI → Agents to change that.
Install the modular command#
Settings → General → Desktop → CLI puts modular and kanbo on your PATH
(macOS and Windows). See The CLI.
Next#
- The canvas: moving around, the studios, keyboard shortcuts.
- Agents: what an agent can do from its terminal.
- The board: cards, and handing one to an agent.