# Solipsist

> Think and work with AI agents in your markdown docs. They suggest; you decide.

Solipsist is a local markdown editor that runs on a folder of `.md` files. You work on copies in `.solipsist/`, and
**Sync to file** writes back only what you changed. AI agents (Pi, built in) work on requests in the background and
every result comes back as a suggestion to accept, reject, ask again or chat about. It runs with Bun from a clone of
https://github.com/pulkitsharma07/solipsist. Every page below is also in one file: https://solipsist.sh/llms-full.txt

## Overview

- [Solipsist documentation](https://solipsist.sh/docs/index.md): What Solipsist is, how it keeps your files safe, and where to go next.

## Start here

- [Install and run](https://solipsist.sh/docs/start/install.md): Run Solipsist on a folder of markdown files.
- [Connect a model](https://solipsist.sh/docs/start/connect-a-model.md): Give the built-in agent a model to run on.
- [OpenRouter](https://solipsist.sh/docs/start/openrouter.md): One key for many models, and where to see what each costs.
- [Local models](https://solipsist.sh/docs/start/local-models.md): Run the agents on a model on your own computer, through Pi.
- [Your first request](https://solipsist.sh/docs/start/first-request.md): Ask an agent for something, then decide what to do with its suggestion.

## Guides

- [Files and Sync](https://solipsist.sh/docs/guides/files-and-sync.md): How Solipsist keeps your original files safe, and how your changes get back to them.
- [Asking for something](https://solipsist.sh/docs/guides/requests.md): The three kinds of request and what each one works on.
- [Suggestions](https://solipsist.sh/docs/guides/suggestions.md): Reviewing what an agent suggests, and every way to decide.
- [Buttons](https://solipsist.sh/docs/guides/buttons.md): Keep a request as a button you can press, or schedule, to run it again.
- [Page review](https://solipsist.sh/docs/guides/page-review.md): Get questions about a page in the margin, without a word of it changing.

## Agents

- [How the agents work](https://solipsist.sh/docs/agents/how-agents-work.md): One agent per request, what they're told, and the limits that keep them in check.
- [Chat](https://solipsist.sh/docs/agents/chat.md): Talk to the agent behind a suggestion, or to one about the whole page.
- [Prompts](https://solipsist.sh/docs/agents/prompts.md): Read and change everything the agents are told.
- [For AI agents](https://solipsist.sh/docs/agents/for-agents.md): How a coding agent can read these docs, put requests in a page, and drive a Solipsist headless.
- [The protocol](https://solipsist.sh/docs/agents/protocol.md): Exactly what every agent is told about tasks, markers and how to reply.

## Engines

- [Engines](https://solipsist.sh/docs/engines/overview.md): What runs the agents, what it needs, who pays, and what it can touch.
- [Pi](https://solipsist.sh/docs/engines/pi.md): The agent engine, with its login, its configuration, its tools and its models.
- [When it goes wrong](https://solipsist.sh/docs/engines/when-it-goes-wrong.md): The messages you can see when an agent can't run, and what fixes each.

## Reference

- [Configuration](https://solipsist.sh/docs/reference/configuration.md): Every setting, its default, and where it can be set.
- [Keyboard](https://solipsist.sh/docs/reference/keyboard.md): Every shortcut Solipsist adds to the editor.
- [Status bar](https://solipsist.sh/docs/reference/status-bar.md): What each part of the bar at the bottom of the page tells you, and what clicking it does.
- [Agent panel](https://solipsist.sh/docs/reference/agent-panel.md): Change the page's model, turn its agents off and on, and see what every run did, step by step.
- [Command line](https://solipsist.sh/docs/reference/cli.md): The flags the server takes, and how to see which settings are in effect.
- [Page format](https://solipsist.sh/docs/reference/page-format.md): How requests, suggestions and comments are stored inside a plain markdown file.
- [Privacy and security](https://solipsist.sh/docs/reference/privacy.md): What leaves your machine, and what an agent can do on it.

## Optional

- [Every feature](https://solipsist.sh/features.html): each part of the app, drawn with its real HTML
- [Source](https://github.com/pulkitsharma07/solipsist): the repository, with `AGENTS.md` for coding agents