> For the complete documentation index, see [llms.txt](https://docs.nimbalyst.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nimbalyst.com/getting-started/quickstart.md).

# Quickstart

Set up Nimbalyst in minutes. Open a project, connect a coding agent, and run your first AI session in a visual interface for Claude Code.

This page gets you from download to your first AI session: install the app, open a project folder, connect a coding agent, and learn the three modes you will work in. It takes a few minutes end to end.

Start by downloading the app from the [Nimbalyst download page](https://nimbalyst.com/download/). Mac, Windows, and Linux builds are all there. On Linux, choose between an AppImage and a `.deb` package for Debian and Ubuntu; the `.deb` works on Ubuntu 24.04 and later, where AppArmor's user-namespace restriction blocks the AppImage.

### Open a Project

<div align="left"><figure><img src="https://562749618-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiVUeHZHlFlZrZt02syRC%2Fuploads%2FPf0U8CK9wIqBhPvWohpG%2Fimage.png?alt=media&amp;token=a65eba65-4e9f-4db8-b22d-e3025b932370" alt="The Project Manager with Open Folder and New Folder buttons and a list of recent project folders on the left" width="563"><figcaption><p>The Project Manager: open any folder as a project, or pick one of your recent projects from the list.</p></figcaption></figure></div>

* A project is a folder opened in Nimbalyst. It keeps its own history, context, and window state, and that state is restored when you reopen the folder.
* If you have git repositories locally, open those; if not, create a folder such as `Nimbalyst Projects` and work there.
* You can have multiple Nimbalyst windows open on different projects at the same time. A consistent color per project helps you tell them apart.
* Return to this screen from **Window > Project Manager** or **Cmd+P** to open another project.
* You can only view and edit files that are inside your project, but your coding agent can read and change files elsewhere on your computer if you give it permission.

### Coding Agents

Nimbalyst includes provider integrations for Claude Agent and OpenAI Codex, so you do not need to install their command-line tools for the standard in-app agents.

1. Open **Settings > Application > AI Providers** and choose a provider.
2. For Claude Agent, sign in with an eligible Claude plan or enter an Anthropic API key. For OpenAI Codex, sign in with an eligible ChatGPT plan or enter an OpenAI API key.
3. Start a session and select the provider from the composer. If it still needs authentication, Nimbalyst will guide you to the relevant settings.

Separate CLI providers are also available for workflows that specifically need an installed command-line agent. See [AI provider setup](/setup-nimbalyst/ai-provider-setup-and-notifications.md) for the differences and current authentication options.

### Files Mode

Files mode (**Cmd+E**) is where you work on one file at a time with an agent beside you: interactive WYSIWYG markdown docs, mermaid diagrams, excalidraw drawings, html mockups, data models, CSV files, Calc Sheets, in-app browser previews, mind maps, and code.

* Edit the file in the center panel. See red/green diffs from your coding agent, review them, and accept them.
* Work with your agent in the right panel to edit this file, explore other files, or research the web.
* Navigate and manage your files in the left panel file manager.

<figure><img src="https://562749618-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiVUeHZHlFlZrZt02syRC%2Fuploads%2FwlRCXOFONAHjdMIBmyQh%2F1.png?alt=media&amp;token=dd138168-d92e-4650-832d-3b2969013fbd" alt="Files mode with the file tree on the left, a markdown plan with red/green AI diffs and an embedded mermaid diagram in the center, and the AI assistant panel on the right"><figcaption><p>Files mode: file management on the left, red/green AI diffs to review in the document, and the AI assistant on the right.</p></figcaption></figure>

#### Edit Markdown

* Nimbalyst uses standard Markdown files for documents, while visual editors use their own open or plain-text project files.
* Work in native markdown mode or in the WYSIWYG editor with markdown commands.
* Open a markdown document from your folder and start editing, or create one with the new-document icon or **File > New** (**Cmd+N**).
* Save with **Cmd+S**. Documents are saved as standard markdown files on disk, so you or other AIs can edit them in other applications too.
* **Cmd+Y** opens the file's history so you can review and restore earlier versions.

#### Calc Sheets

* Create a `.calc.md` file when you want spreadsheet-style results in a markdown document.
* Useful for pricing, estimates, budgets, unit conversions, and planning notes with formulas.
* You keep the source as plain text while Nimbalyst renders evaluated values beside it.
* See [Calc Sheets](/visual-editors-powered-by-ai/calc-sheets.md).

#### Browser

* Open `.html` files or live URLs in a real Chromium view inside Nimbalyst.
* Preview generated pages, inspect mockups, and verify frontend changes without switching apps.
* Ask your agent to navigate, click, type, scroll, evaluate, or screenshot the page.
* See [Browser](/visual-editors-powered-by-ai/browser.md).

#### Mind Map

* Create a `.mindmap` file when a roadmap, plan, or research topic is easier to understand spatially.
* Mind maps give you an infinite canvas with branches, notes, tags, colors, and AI-assisted expansion.
* The file stays readable and versionable, so agents can edit it like other project files.
* See [Mind Map](/visual-editors-powered-by-ai/mind-map.md).

#### AI Chat Panel

* Use the AI chat panel to edit your documents or do research.
* Select a provider from the dropdown. See [AI Provider Setup and Notifications](/setup-nimbalyst/ai-provider-setup-and-notifications.md) to set up Claude Code, Codex, and other providers.
* The agent can see and operate on your current document and your whole project.
* Type `@` to attach a file or folder to the conversation. In markdown documents, putting a supported custom-editor file reference on its own line turns it into an inline embed.
* Use the **Actions** dropdown to insert reusable prompts like reviewing changed files, planning an implementation, drafting release notes, or inspecting the current editor.
* AI edits show up as red/green diffs for your approval.
* Each AI conversation is a session that can be saved and resumed.

#### Edit Mockups

<figure><img src="https://562749618-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiVUeHZHlFlZrZt02syRC%2Fuploads%2FSPJYNzOb4qnYSrEffLzO%2F2.png?alt=media&amp;token=33b72743-0c51-4ea7-bac9-6f6e1545bc3b" alt="An html mockup of a bank sign-up form open in the mockup editor, with a red annotation circled on the form and the AI chat panel on the right"><figcaption><p>Draw an annotation on a mockup, then ask the agent to make the change you circled.</p></figcaption></figure>

* Create a mockup by typing `/mockup` in the agent panel, then click to open it in the editor.
* Edit it by modifying the html source, by annotating it (drawing on it), or by selecting a div and asking the agent for changes.
* Embed the mockup into a document by typing `/` in the document.

### Agent Mode

Agent mode (**Cmd+K**) is where you run and manage AI sessions: organize, find, and continue your conversations, track the files each session changed, and step through and approve every diff, with all the power of Claude Code and Codex plus / command support and GitHub status tracking.

<figure><img src="https://562749618-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiVUeHZHlFlZrZt02syRC%2Fuploads%2FI8CIAeODNM9IBQiJwwKR%2F3.png?alt=media&amp;token=ff5ee5eb-5ebe-4d9c-bb47-4bd409432a76" alt="Agent mode with the session list on the left, a transcript showing red/green CSS edits in the center, and the files the agent edited and read on the right"><figcaption><p>Agent mode: sessions on the left, the transcript with red/green edit cards in the center, and the files the agent touched on the right.</p></figcaption></figure>

* Your conversation with the agent is in the central panel.
* The left panel lists your sessions. Group related sessions into workstreams.
* The right panel lists the files the agent touched in the session or workstream. Click a file to open it in the center; right-click to open it in Files mode.

If you already have a history of sessions in the Claude Code CLI, bring them into Nimbalyst with **File > Import Claude Code Sessions...**. See [Import Claude Code Sessions](/session-management/import-claude-code-sessions.md).

### Team and Collaboration Setup

To collaborate with other people in a project:

1. Sign in under **Settings > Account > Accounts**.
2. Make sure the project has a git remote named `origin`.
3. Open **Settings > Project > Sharing** and create a team, join an invitation, or add the repository to an organization you already administer.
4. Invite teammates from the organization's member settings.
5. Open **Collaboration** mode to create shared documents, or right-click a supported local file and choose **Share to Team**.
6. Open **Trackers** to work on shared tracker types or promote hybrid items into the team tracker.

<figure><img src="https://562749618-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiVUeHZHlFlZrZt02syRC%2Fuploads%2Fgit-blob-b3694ea2879264e4f754949d3daa4924c95d8ce1%2Fteam-collab-presence.png?alt=media" alt="A shared planning document with teammate presence avatars and a live labeled cursor"><figcaption><p>Once the team is connected, people and their agents can work together in the same shared documents and trackers.</p></figcaption></figure>

See [Set Up Nimbalyst Teams and Organizations](/team-collaboration/setup-teams-and-orgs.md) for the complete settings flow and [Team Collaboration Overview](/team-collaboration/overview.md) for how local and shared work fit together. To go further, [Nimbalyst Teams: Step by Step](/team-collaboration/teams-tutorial.md) walks the whole flow in seven steps with a screenshot for each.

### Mobile App

Manage your AI coding agents on the go with the Nimbalyst mobile app:

* **Session dashboard:** see all active, completed, and paused sessions at a glance.
* **Diff review:** swipe through file changes with red/green diffs optimized for mobile.
* **Resume and reassign:** resume stalled sessions with a voice note or typed instruction from your phone.
* **Push notifications:** get notified when sessions complete, hit errors, or need approval.
* **Desktop sync:** changes approved on mobile appear on desktop right away.
* **All agents:** manage Claude Code and Codex sessions from one app.

See the [mobile app](/mobile/mobile-app.md) docs for details.

### Shortcuts

Open **Help > Keyboard Shortcuts** or press **Cmd+/** for the full list. A few to start with:

* **Cmd+O**: Unified Quick Open in the Files tab, with tabs for content search, sessions, prompts, projects, and trackers
* **Cmd+K**: Agent mode
* **Cmd+E**: Files mode
* **Cmd+N**: New file or session
* **Cmd+Shift+N**: New AI session from any mode
* **Cmd+Shift+K**: Session kanban board
* **Cmd+\[** / **Cmd+]**: Navigate back and forward
* **Cmd+Shift+V**: Force-paste as plain text

### 15-minute guided quickstart

Learn Nimbalyst by doing real work in about 15 minutes. Product managers, founders, and designers finish with a working brief and an embedded mockup. Developers finish with a run-and-test guide, an embedded architecture diagram, and two agents running in parallel.

Open a workspace in Nimbalyst, start a new chat, and paste this prompt:

```
Fetch https://raw.githubusercontent.com/nimbalyst/skills/main/skills/getting-started/quickstart.md, save it to nimbalyst-quickstart/quickstart.md in this workspace, then run it as the Nimbalyst quickstart. Wait for me at every exercise.
```

The agent saves the quickstart in your workspace, helps you choose the product or engineering track, and waits for you at each exercise. Everything it creates stays under `nimbalyst-quickstart/`, so you can remove the folder afterward if you do not want to keep the results.

The [Nimbalyst quickstart on GitHub](https://github.com/nimbalyst/skills/blob/main/skills/getting-started/quickstart.md) is the source of truth.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.nimbalyst.com/getting-started/quickstart.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.