# NimWiki docs

> A visual wiki your coding agent writes and keeps current, for working through a strategy or making a decision.

## Get started

- [Introduction](https://nimwiki.com/docs/index.md): NimWiki is a wiki your agent writes with you, built to help you understand a problem, make a decision and share it, in place of a slide deck.
- [Install](https://nimwiki.com/docs/getting-started/install.md): Tell your agent to install NimWiki and it finds the rest, or install by hand in Claude Code, Codex or any MCP agent, with no account and no app to install.
- [Quickstart](https://nimwiki.com/docs/getting-started/quickstart.md): Start a local wiki, let your agent write the first pages, record a decision and open the wiki in your browser.

## Write the wiki

- [Pages and components](https://nimwiki.com/docs/writing/pages-and-components.md): The kinds of pages a wiki holds, and the blocks you can put inside a page, from callouts and tabs to 2x2s, charts, decision blocks and Mermaid diagrams.
- [Drawings, sheets and HTML pages](https://nimwiki.com/docs/writing/drawings-sheets-and-html-pages.md): Make Excalidraw drawings, mind maps, spreadsheets, calc sheets, mockups, canvases and interactive HTML pages part of the wiki, and embed them in the pages they explain.
- [Typed pages](https://nimwiki.com/docs/writing/typed-pages.md): Track competitors, customers, options or anything else you keep several of, each as a page with fields in its header and all of them in one table.
- [Decisions and open questions](https://nimwiki.com/docs/writing/decisions-and-questions.md): Record each decision in the page it affects with who decided, when and what was passed over, keep open questions with their owners, source your facts, and ask the wiki what was decided.
- [Edit the files](https://nimwiki.com/docs/writing/edit-the-files.md): A local wiki is a folder of plain markdown files you own, so you can read, edit, diff and commit it with any tool.

## Use it

- [Working with your agent](https://nimwiki.com/docs/using/working-with-your-agent.md): What to ask your agent day to day, how it decides which wiki to use, what it does on its own, and how to keep the wiki tidy.
- [Browser view](https://nimwiki.com/docs/using/browser-view.md): Read and edit a local wiki in your browser, with the page tree, the page editor, drawings, sheets and type tables, served from your own machine behind a token.

## Share

- [Promote to a team](https://nimwiki.com/docs/sharing/promote-to-team.md): Move a local wiki to a team wiki with one request. The agent walks you through sign-in and shows what will move before it moves anything, so everyone edits the same pages and every teammate's agents write into them.
- [Invite people](https://nimwiki.com/docs/sharing/invite.md): Invite people to a team wiki by email or with an invite link, choose what they can do, and set up their agents to use the same pages.
- [Publish as a static site](https://nimwiki.com/docs/sharing/publish-static-site.md): Export a local wiki as a read-only website with nim wiki export --static, choose what to leave out, and host it on Cloudflare or any static host.

## Reference

- [CLI reference](https://nimwiki.com/docs/reference/cli.md): The nim commands for working with a wiki from a terminal or a script, covering local pages, the browser view, typed pages, static export, team wikis and updates.
- [Upgrade](https://nimwiki.com/docs/reference/upgrade.md): Keep the plugin and the nim command line up to date with one command, or update each agent's plugin by hand.
- [Pricing FAQ](https://nimwiki.com/docs/pricing-faq.md): A local wiki and a self-hosted static site are free. A hosted wiki costs $8 per month for each person who edits it, and is free while NimWiki is in beta.