# Nimbalyst Docs

## Getting Started

- [Why Nimbalyst?](https://nimbalyst.com/docs/index.md): Nimbalyst is an open-source visual workspace for Claude Code and Codex. Learn what it does, who it is for, and how to start working with AI agents.
- [Nimbalyst Tutorial and Demo Videos](https://nimbalyst.com/docs/getting-started/nimbalyst-demo-and-use-cases.md): Three ways to learn Nimbalyst: watch a demo video, explore the sample tutorial workspace that ships with the app, or have an agent walk you through a 15-minute guided quickstart.
- [Quickstart](https://nimbalyst.com/docs/getting-started/quickstart.md): 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.
- [Major Bugs, Outages, Feedback, Discord, Support, Releases](https://nimbalyst.com/docs/getting-started/feedback-discord-support-releases.md): Where to report Nimbalyst bugs, check current outage status, join the Discord community, reach the support team, and follow new releases.
- [Release Announcement Archive](https://nimbalyst.com/docs/getting-started/release-announcements.md): Archive of every Nimbalyst release announcement email, newest first, with the screenshots and links that went out to the community.

## VISUAL EDITORS POWERED BY AI

- [Markdown (WYSIWYG)](https://nimbalyst.com/docs/visual-editors-powered-by-ai/markdown-wysiwyg.md): Nimbalyst is a WYSIWYG AI markdown editor. Write visually while plain .md files stay on disk, with agent editing built into the same document.
- [Find & Replace and ToC](https://nimbalyst.com/docs/visual-editors-powered-by-ai/markdown-wysiwyg/find-and-replace-and-toc.md): Use Cmd+F find and replace plus the auto-generated table of contents to move around long markdown documents in Nimbalyst without scrolling.
- [AI Editing, Red/Green Diff, Approval](https://nimbalyst.com/docs/visual-editors-powered-by-ai/markdown-wysiwyg/ai-editing-red-green-diff-approval.md): How AI editing works in Nimbalyst documents. The agent writes its changes to the file and Nimbalyst shows them as a red and green diff so you can review each one and keep it or revert it.
- [Set Document Type](https://nimbalyst.com/docs/visual-editors-powered-by-ai/markdown-wysiwyg/set-document-type.md): Set Document Type turns a markdown document into a tracked Plan or Decision from the editor's Actions menu, without hand-writing YAML frontmatter.
- [Mermaid Diagrams and Images](https://nimbalyst.com/docs/visual-editors-powered-by-ai/mermaid-diagrams-and-images.md): Insert and edit Mermaid diagrams and images inside Nimbalyst markdown documents, by hand or by asking your AI agent to generate the syntax.
- [Mockups](https://nimbalyst.com/docs/visual-editors-powered-by-ai/mockups.md): Build HTML mockups in Nimbalyst using your docs, code, and sessions as context, then hand the same mockups to your agent to implement.
- [Canvas](https://nimbalyst.com/docs/visual-editors-powered-by-ai/canvas.md): Project Canvas is an infinite board whose cards are live editors for real files. Lay out a plan, a diagram, and a flow of mockups side by side and edit any of them in place.
- [Animations](https://nimbalyst.com/docs/visual-editors-powered-by-ai/animations.md): Author animated explainer diagrams as .anim.json files. Describe what is true at each step, scrub the timeline, and export to MP4 or GIF, with your agent doing the drawing.
- [Data Models](https://nimbalyst.com/docs/visual-editors-powered-by-ai/data-models.md): Design database schemas visually in Nimbalyst. Build a Prisma-based data model with AI from your existing code and markdown documentation.
- [CSV](https://nimbalyst.com/docs/visual-editors-powered-by-ai/csv.md): Open CSV and TSV files in the built-in Nimbalyst spreadsheet editor, edit rows and columns visually, and let your AI agent work the same data.
- [Browser](https://nimbalyst.com/docs/visual-editors-powered-by-ai/browser.md): Preview HTML files and live URLs in the built-in Chromium browser, right next to your project files and your AI coding agent conversation.
- [Calc Sheets](https://nimbalyst.com/docs/visual-editors-powered-by-ai/calc-sheets.md): Calc Sheets are markdown spreadsheets (.calc.md) that keep assumptions, formulas, and outputs in one versionable file your AI agent can edit.
- [Mind Map](https://nimbalyst.com/docs/visual-editors-powered-by-ai/mind-map.md): Mind Map is a spatial editor for .mindmap files. Brainstorm on an infinite canvas while the file stays plain text your AI agent can also edit.
- [Excalidraw](https://nimbalyst.com/docs/visual-editors-powered-by-ai/excalidraw.md): Draw diagrams, flowcharts, and whiteboard sketches in the built-in Excalidraw editor, and let your AI agent build them from a description.
- [PDF Viewer](https://nimbalyst.com/docs/visual-editors-powered-by-ai/pdf-viewer.md): Open and read PDF documents in Nimbalyst tabs alongside your other project files, with smooth scrolling, zoom controls, and text selection.
- [Code Editor](https://nimbalyst.com/docs/visual-editors-powered-by-ai/code-editor.md): Nimbalyst includes a Monaco code editor, the same engine VS Code uses, with syntax highlighting and AI edits next to your docs and diagrams.

## FILE MANAGEMENT

- [File History and Restore](https://nimbalyst.com/docs/file-management/file-history-and-restore.md): Nimbalyst saves file snapshots automatically. Open history with Cmd+Y to compare versions and restore a document after an AI edit goes wrong.
- [File Search, File Tree, and Tabs](https://nimbalyst.com/docs/file-management/editor.md): Find files fast in Nimbalyst with Quick Open (Cmd+O), the project file tree, and tabs for working across several documents at the same time.
- [Multi-Folder Projects](https://nimbalyst.com/docs/file-management/multi-folder-projects.md): Attach additional folders to a project so one workspace spans several repositories. Attached folders appear in the explorer, in search, and to your agents, with git tracked per repository.
- [Project Graph](https://nimbalyst.com/docs/file-management/project-graph.md): Explore your whole project as one navigable surface. Atlas maps your project's areas, Pulse shows where activity moved over time, and Evidence Trails walks the recorded links between trackers, sessions, commits, and files.
- [Share Link to a File](https://nimbalyst.com/docs/file-management/share-link-to-a-file.md): Create an encrypted, expiring public link for a markdown or visual file in Nimbalyst so people outside your workspace can read it in a browser.
- [File Edits Sidebar](https://nimbalyst.com/docs/file-management/file-edits-sidebar.md): The File Edits Sidebar tracks every file your AI agent read or changed during a session, so you can review each modification before accepting.

## SESSION MANAGEMENT

- [Agent Window & Session Management](https://nimbalyst.com/docs/session-management/agent-window-and-session-management.md): Manage AI coding sessions in the Nimbalyst Agent window. Start, resume, group, rename, and search long-running Claude Code and Codex sessions.
- [AI Usage Report](https://nimbalyst.com/docs/session-management/ai-usage-report.md): See which models and tools your AI sessions use, compare activity across projects over time, and find Nimbalyst tools you have not tried yet.
- [View Files in Agent Mode](https://nimbalyst.com/docs/session-management/view-files-in-agent-mode.md): View and edit the files an AI session touches directly inside Agent mode, without switching to Files mode to check what the agent did.
- [Workstreams](https://nimbalyst.com/docs/session-management/workstreams.md): Workstreams group related AI sessions that touch the same files or topic, so you can branch an approach without losing the earlier thread.
- [Import Claude Code Sessions](https://nimbalyst.com/docs/session-management/import-claude-code-sessions.md): Import sessions from the Claude Code CLI into Nimbalyst so you can browse, search, resume, and continue past terminal conversations visually.
- [/ Commands and Skills](https://nimbalyst.com/docs/session-management/commands-and-skills.md): Use Claude Code and Codex slash commands, custom commands, and skills in Nimbalyst, and learn how actions, commands, and skills differ.
- [AI Actions](https://nimbalyst.com/docs/session-management/ai-actions.md): AI Actions are reusable prompt presets that show up in the Nimbalyst composer. Define them in one workspace file so they version and share.
- [Interactive Prompts (PromptForUserInput)](https://nimbalyst.com/docs/session-management/interactive-prompts.md): PromptForUserInput is a built-in Nimbalyst tool that lets your agent collect several answers at once through one structured widget.
- [Automations](https://nimbalyst.com/docs/session-management/automations.md): Schedule recurring AI tasks in Nimbalyst. Automations run on a timer from a markdown file to produce standups, weekly reports, and reviews.
- [Share Link to a Session](https://nimbalyst.com/docs/session-management/share-link-to-a-session.md): Create a public share link for an AI session so anyone can read the full transcript in a browser without installing Nimbalyst.

## TASK MANAGEMENT

- [Tracker Overview](https://nimbalyst.com/docs/task-management/overview.md): Nimbalyst has a built-in issue tracker that keeps bugs, features, tasks, and plans in your project, next to your docs and AI sessions.
- [Item Types and Fields](https://nimbalyst.com/docs/task-management/item-types-and-fields.md): Nimbalyst ships seven built-in tracker item types, each with its own status workflow, fields, and icon. Learn what each type is meant to track.
- [Views: Kanban, List, and Tag Board](https://nimbalyst.com/docs/task-management/kanban-and-list.md): Switch between kanban board, list, and tag board views in the Nimbalyst tracker, then save any filter and grouping as a named view to reuse.
- [Item Detail, Comments, Activity](https://nimbalyst.com/docs/task-management/item-detail.md): Open a tracker item to edit fields in place, write the body, add comments, and follow the full activity history of a piece of work.
- [Creating Items](https://nimbalyst.com/docs/task-management/creating-items.md): Several ways to create tracker items in Nimbalyst, from asking your AI agent during a session to writing inline tags or YAML in markdown.
- [Referencing Tracker Items](https://nimbalyst.com/docs/task-management/referencing-tracker-items.md): Drop a live reference to any tracker item into a document or AI chat. The chip shows the current status and title and stays up to date.
- [Linking Tracker Items](https://nimbalyst.com/docs/task-management/linking-tracker-items.md): Link tracker items to each other with parent, blocks, and duplicate relationships. Links are two-way, so setting one side updates the other.
- [Sharing Plans and Trackers](https://nimbalyst.com/docs/task-management/sharing-plans-and-trackers.md): How to share Nimbalyst plans and tracker items with teammates, and how personal and shared trackers differ in practice.
- [AI Integration](https://nimbalyst.com/docs/task-management/ai-integration.md): AI agents in Nimbalyst can create, update, and query tracker items during a session. Link the ones that matter, or turn agent access off.
- [Commits and Session Linking](https://nimbalyst.com/docs/task-management/commits-and-sessions.md): Reference a tracker item ID in a git commit message and Nimbalyst links that commit to the item, giving traceability from idea to shipped code.
- [Linking Sessions and Tracked Items](https://nimbalyst.com/docs/task-management/linking-sessions-and-tracked-items.md): Link AI sessions to tracker items so the conversation behind a bug fix or a design decision stays attached to the work item it produced.
- [Custom Tracker Types](https://nimbalyst.com/docs/task-management/custom-tracker-types.md): Define your own tracker types in Nimbalyst with YAML config files or from Settings. Custom types get the same board, detail view, and AI integration.
- [The nim CLI](https://nimbalyst.com/docs/task-management/nim-cli.md): nim is a command-line tool for Nimbalyst trackers. List, create, update, comment, archive, and import items from your shell, and pipe JSON out.
- [Local Config](https://nimbalyst.com/docs/task-management/local-config.md): Where Nimbalyst keeps tracker type definitions and markdown-backed items, and which tracker settings live in the app.

## DEVELOPER FEATURES

- [Coding with Coding Agents & Nimbalyst](https://nimbalyst.com/docs/developer-features/coding-with-claude-code-and-nimbalyst.md): How to code with Claude Code and Codex inside Nimbalyst, a visual interface for coding agents with your files, diffs, and sessions side by side.
- [Basics on Code/Git for Non-Devs](https://nimbalyst.com/docs/developer-features/basics-on-code-git-for-non-devs.md): A plain-language introduction to code and git for product managers and designers who want to use a coding agent without a dev background.
- [Turn on/off Developer Mode](https://nimbalyst.com/docs/developer-features/turn-on-off-developer-mode.md): Turn Developer Mode on or off in Nimbalyst to show or hide the terminal, git worktrees, and the other git features you may not need.
- [Terminal Window](https://nimbalyst.com/docs/developer-features/terminal-window.md): Run a Ghostty-powered terminal inside Nimbalyst. Create multiple terminal sessions in your workspace directory that survive app restarts.
- [Worktrees](https://nimbalyst.com/docs/developer-features/worktrees.md): Use git worktrees in Nimbalyst to run AI coding agents on several branches at once, each with its own directory, session, and diff to review.
- [Working with Git](https://nimbalyst.com/docs/developer-features/working-with-git.md): Commit, check status, and manage branches in Nimbalyst with AI-generated commit proposals and git file status colors in the file tree.
- [Pull Request Reviews](https://nimbalyst.com/docs/developer-features/pull-request-reviews.md): Review GitHub pull requests inside Nimbalyst. Read the diff, run an AI review, open the branch in a worktree, then comment, approve, or merge.
- [Agent Teams](https://nimbalyst.com/docs/developer-features/agent-teams-and-super-loops.md): Agent Teams let one coding agent session spawn parallel teammate agents. Super Loops run an agent iteratively on one task until it is complete.

## TEAM COLLABORATION

- [Nimbalyst Teams: Step by Step](https://nimbalyst.com/docs/team-collaboration/teams-tutorial.md): A step-by-step walkthrough of Nimbalyst Teams: sign in, invite your team, and work together in shared trackers and documents with your coding agents.
- [Team Collaboration Overview](https://nimbalyst.com/docs/team-collaboration/overview.md): How Nimbalyst Teams adds shared documents and trackers on top of each teammate’s local workspace and their own locally running coding agents.
- [Collaborative Documents](https://nimbalyst.com/docs/team-collaboration/documents.md): Share markdown docs, mockups, and diagrams with your team. Teammates and their local coding agents edit the same files in real time.
- [Collaborative Trackers](https://nimbalyst.com/docs/team-collaboration/trackers.md): Share one tracker board across your team. Teammates and their locally running AI agents keep the same bugs, features, and plans current.
- [Ask Your Team for Feedback](https://nimbalyst.com/docs/team-collaboration/feedback-requests.md): Ask teammates a structured question about a document, mockup, or diagram. Your agent drafts the request, it lands in their inbox with the artifacts attached, and you get a tally instead of a thread.
- [Decision Blocks in Documents](https://nimbalyst.com/docs/team-collaboration/decisions.md): Put a decision question inside the document it is about. Author it as an answerable field, decide it yourself or ask teammates, and seal an attributed outcome that stays in the markdown.
- [Web Console (console.nimbalyst.com)](https://nimbalyst.com/docs/team-collaboration/web-console.md): Open your team's shared documents in a browser at console.nimbalyst.com, edit them live with teammates, leave comments, and manage your organization.
- [Set Up Nimbalyst Teams](https://nimbalyst.com/docs/team-collaboration/setup-teams-and-orgs.md): Create a Nimbalyst organization, attach a project to it, invite teammates, and manage members, projects, messaging, and encryption from the organization management dialog.

## EXTENSIONS

- [Extension System & Marketplace](https://nimbalyst.com/docs/extensions/extension-system-and-marketplace.md): Install Nimbalyst extensions from the marketplace registry to add editors, AI tools, and panels, or publish an extension you built yourself.
- [Building Your Own Extensions](https://nimbalyst.com/docs/extensions/building-extensions.md): Build your own Nimbalyst extension with custom editors, AI tools, panels, and themes, packaged with a manifest that declares what it adds.
- [Getting Started](https://nimbalyst.com/docs/extensions/building-extensions/getting-started.md): Create your first Nimbalyst extension step by step, ending with a working custom editor for a new file type built on the extension SDK.
- [Custom Editors](https://nimbalyst.com/docs/extensions/building-extensions/custom-editors.md): Build a custom editor extension for Nimbalyst: the useEditorLifecycle hook, the EditorHost interface, undo and redo, and large file handling.
- [AI Tools](https://nimbalyst.com/docs/extensions/building-extensions/ai-tools.md): Add AI tools to a Nimbalyst extension so coding agents can read and change your custom file types instead of only seeing raw file content.
- [Manifest Reference](https://nimbalyst.com/docs/extensions/building-extensions/manifest-reference.md): Full reference for the Nimbalyst extension manifest.json: required fields, permissions, contributions, file pattern syntax, and validation.
- [API Reference](https://nimbalyst.com/docs/extensions/building-extensions/api-reference.md): TypeScript API reference for @nimbalyst/extension-sdk, covering ExtensionContext, custom editors, AI tools, panels, storage, and manifest types.

## MOBILE

- [Mobile App](https://nimbalyst.com/docs/mobile/mobile-app.md): Run your desktop coding agents from your phone with Nimbalyst Mobile. Start and resume sessions, answer approvals, and edit synced markdown on the go.
- [Voice on Mobile](https://nimbalyst.com/docs/mobile/voice-on-mobile.md): Talk to the coding agents running on your desktop from the Nimbalyst iOS app. Voice relays what you say and speaks the result back to you.

## SETUP Nimbalyst

- [AI Provider Setup and Notifications](https://nimbalyst.com/docs/setup-nimbalyst/ai-provider-setup-and-notifications.md): Connect Claude, Codex, Copilot, and other AI providers in Nimbalyst, add keys or subscriptions, and set up session completion notifications.
- [Application, Account, and Project Settings](https://nimbalyst.com/docs/setup-nimbalyst/settings-scopes.md): Nimbalyst splits settings into application, account, and project scopes, so it is clear whether a change applies everywhere or to one project.
- [Set Up Nimbalyst Teams](https://nimbalyst.com/docs/team-collaboration/setup-teams-and-orgs.md): Create a Nimbalyst organization, attach a project to it, invite teammates, and manage members, projects, messaging, and encryption from the organization management dialog.
- [Claude Code in Vertex, Bedrock](https://nimbalyst.com/docs/setup-nimbalyst/claude-code-in-vertex-bedrock.md): Configure Claude Code in Nimbalyst to run through Google Vertex AI or Amazon Bedrock using your own cloud account and existing credentials.
- [MCP](https://nimbalyst.com/docs/setup-nimbalyst/mcp.md): Add MCP servers to Nimbalyst so your coding agent can reach GitHub, Linear, Slack, and other services. Covers install, config, and permissions.
- [Alpha Features](https://nimbalyst.com/docs/setup-nimbalyst/alpha-features.md): Find and enable alpha features in Nimbalyst, understand the separate Alpha update channel, and see which capabilities are still experimental.
- [Voice Mode](https://nimbalyst.com/docs/setup-nimbalyst/voice-mode.md): Talk to your coding agent and hear it reply. How to turn on Nimbalyst Voice Mode on desktop and mobile, pick a voice, and run hands-free.

## Open, Safe, Private, Secure

- [Open Data, Workflow, File Storage](https://nimbalyst.com/docs/open-safe-private-secure/open-data-workflow-file-storage.md): Nimbalyst keeps your documents, metadata, and settings in open formats on your own machine, and the app itself is open source on GitHub.
- [Permissions and Safety](https://nimbalyst.com/docs/open-safe-private-secure/permissions-and-safety.md): How Nimbalyst permissions keep AI agents in bounds by approving file writes and shell commands, and guarding against prompt injection.
- [Privacy](https://nimbalyst.com/docs/open-safe-private-secure/privacy.md): Nimbalyst is local first. Files, app state, and agents stay on your machine, and online features move only the data that feature needs.
- [Session and Window State Storage](https://nimbalyst.com/docs/open-safe-private-secure/session-and-window-state-storage.md): Where Nimbalyst stores AI session history and window state on your machine, including the local database location on macOS, Windows, and Linux.
- [Security](https://nimbalyst.com/docs/open-safe-private-secure/security.md): How Nimbalyst handles files, sessions, and credentials, with open source code your security team can audit and encryption for shared data.

## FAQs

- [FAQs](https://nimbalyst.com/docs/faqs/faqs.md): Answers to common Nimbalyst questions about open source, Claude Code custom commands, multiple workspaces, data privacy, offline use, and file associations.

## Troubleshooting

- [Troubleshooting](https://nimbalyst.com/docs/troubleshooting/troubleshooting.md): Fix common Nimbalyst problems, including agents not responding, provider outages, API key and login errors, sync issues, and install trouble.
- [Database Backups and Restore](https://nimbalyst.com/docs/troubleshooting/database-backups-and-restore.md): Where Nimbalyst stores its automatic database backups on macOS, Windows, and Linux, and how to restore one by hand for both the SQLite and PGLite backends.

## Detailed Install Guides

- [Windows: Detailed Install Guide](https://nimbalyst.com/docs/detailed-install-guides/windows-detailed-install-guide.md): Install Nimbalyst on Windows, open a project, and connect Claude Agent or OpenAI Codex using a plan login or API key.
- [Mac: Detailed Install Guide](https://nimbalyst.com/docs/detailed-install-guides/mac-detailed-install-guide.md): Install Nimbalyst on macOS, open a project, and connect Claude Agent or OpenAI Codex using a plan login or API key.