# Quickstart

Download [Nimbalyst](https://nimbalyst.com/)

### **Open a Project**

<div align="left"><figure><img src="/files/dzPiweAJHx4y4qgzu0IE" alt="" width="563"><figcaption></figcaption></figure></div>

* A project is a folder opened in Nimbalyst that maintains its history, context, window state.
  * If you have GitHub locally, you would choose various GitHub projects
  * If you don't, create a folder in your filesystem called Nimbalyst Projects
* Open a folder into Nimbalyst and work there
* You can have multiple Nimbalyst screens open working in different projects at the same time. A consistent color will help you tell them apart.
* Project state is automatically saved and restored when you reopen the folder
* (Return to this screen from Windows -> Project Manager or Command P to open another project)
* You can only view and edit files that are in your Nimbalyst project, but you can have your coding agent read, use, manipulate files elsewhere on your computer if you give permission.

#### Multi-Project Rail

Host several projects side-by-side in a single window using the Discord-style vertical rail on the left edge. Switching is instant, and inactive projects stay warm — AI sessions keep streaming, file watchers keep firing, transcripts keep updating, and tabs and panel layouts are preserved per project.

* Enable under **Settings → Advanced → General → Multi-project Mode**
* **Cmd/Ctrl+1..9** activates the Nth project on the rail
* **Cmd/Ctrl+Shift+W** closes the active project
* Right-click a rail icon for **Open in new window**, **Reveal in Finder/Explorer**, and **Close project**
* Click the **+** at the bottom of the rail to add another project to the window

### **Coding Agents**

Nimbalyst is the open-source visual workspace for building with Codex, Claude Code, and more. At least one coding agent must be installed.

* If you already have a coding agent installed and running on your desktop, we will use it through its SDK.
  * If you do not have Claude Code CLI, we will install it for you automatically.
  * You must install Codex CLI yourself prior to using Nimbalyst.
* You must either enter your API Key in the Settings in Nimbalyst or authenticate to OpenAI or Anthropic in their CLIs.

### **Files Mode**

Work with Claude Code and Codex in interactive, WYSIWYG markdown docs, mermaid diagrams, excalidraw drawings, html mockups, data models, csv, sessions and code.

Focus on one file:

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

<figure><img src="/files/0PzRCHU1Zdqo1ZwmaC0w" alt=""><figcaption></figcaption></figure>

#### Edit Markdown

* Nimbalyst uses Markdown for everything (content, data, metadata)
* Work in native markdown mode or in the WYSIWIG Editor with markdown commands
* Open a markdown document from your folder, start editing it manually
* Or create a New Document by clicking the icon or ... File > New (Cmd+N) creates a new document
* Save with Cmd+S. Documents are saved as standard markdown files
* Remember your documents are on disk in your file system and so they can be edited by other AIs or you in other applications
* Cmd + Y will give you your file history and let you use it

#### AI Chat Panel

* Leverage the AI Chat panel to edit your documents or do research / chats
* 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 first time you try to use a coding agent, if you are not authenticated, the Agent chat will step you through authenticating.
* The AI Agent can see and operate on your current document and your whole project
* AI Edits show up as Red/Green Diffs for your approval
* Each AI conversation is a session which can be saved and resumed

#### **Edit Mockups**

<figure><img src="/files/59r1dWmCxyRbMKg0b2TX" alt=""><figcaption></figcaption></figure>

* Create a mockup by typing /mockup in the agent panel . Click to open it in the editor.
* Edit via modifying the html source or by annotating it (draw on it) or by selecting a div and then ask the agent to make changes
* Embed the mockup into your document by typing /

### **Agent Mode**

* *Session Management:* organize, find, and continue your AI conversations. Track the files changed by a session and coordinate your stepping through and approving each one.
* *Coding support:* All the power of Claude Code and Codex plus file tracking, diff visualization, code editing, and / command support with Github status tracking.

<figure><img src="/files/5xdeO3v76b5uzMBgk6T6" alt=""><figcaption></figcaption></figure>

* You conversation with the agent is in the central panel. Focus on this interaction
* The left panel contains the list of your sessions. Group sessions together into workstreams
* The right panel contains the files that the agent touched in that session or group of sessions. Click on 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).

### 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 & 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 instantly on desktop
* **All Agents** — manage Claude Code and Codex sessions from one app

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

### Shortcuts

* Click Help -> Shortcuts or enter Command / to see a list of shortcuts for Nimbalyst
* **Cmd+O** — Quick Open for recent documents
* **Cmd+P** — Project Quick Open to switch between projects
* **Cmd+K** — Agent Mode
* **Cmd+E** — Files Mode
* **Cmd+N** — New File/Session
* **Cmd+Shift+N** — New AI session from any mode
* **Cmd+Shift+K** — Session Kanban board
* **Cmd+L** — Quick Session Open
* **Cmd+\[** / **Cmd+]** — Jump between tabs
* **Cmd+Shift+V** — Force-paste as plain text

### Tutorial

Learn coding agents and Nimbalyst from this tutorial that uses Claude Code to auto-adjust the curriculum and examples for you based on your interests and experience.

* Download the tutorial (it is a markdown document) to your desktop from the Google Drive here <https://drive.google.com/file/d/1CrGERVGrtqTfs-RHonkWiSEVdk66IFhd/view?usp=sharing>
* Chat with your coding agent in Nimbalyst and ask it to copy the Tutorial doc so you can use it as a slash (/) command. Then type /cctutorial in Nimbalyst and the tutorial will auto-detect that you are in Nimbalyst and teach you both Claude Code and Nimbalyst together.


---

# Agent Instructions: 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:

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

The question should be specific, self-contained, and written in natural language.
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.
