# slivingdoc

> A shared, durable notebook for people and agents, built on the Model Context Protocol (MCP) and backed by an S3-compatible bucket.

## Start
- [Introduction](https://www.slivingdoc.dev/docs.md): What slivingdoc is, its two operations, who it is for, and where to go next.
- [Quickstart](https://www.slivingdoc.dev/docs/quickstart.md): From nothing to a shared notebook: point slivingdoc at a bucket, prove it from the command line, then add it to an MCP host.
- [Installation](https://www.slivingdoc.dev/docs/installation.md): The npm launcher, the direct binary download, the supported platforms, and how to check the version.

## Guides
- [Connect an MCP host](https://www.slivingdoc.dev/docs/guides/mcp-hosts.md): Register the server in Claude Code, Codex, Gemini CLI, OpenCode, or pi, and choose how credentials reach it.
- [Use the CLI without a host](https://www.slivingdoc.dev/docs/guides/cli.md): Pull and commit by hand, how a notebook path resolves, how to read the success and error reports, and how to drive both from scripts.
- [Set up a bucket](https://www.slivingdoc.dev/docs/guides/bucket.md): What the bucket must support, and three ways to get one: AWS S3 with the Terraform module, Tigris, and a local SeaweedFS container.
- [Share a directory with humans](https://www.slivingdoc.dev/docs/guides/shared-directory.md): The private session directory, the fixed workspace root that humans and agents share, the private root rule, and the shared pack cache.
- [Restrict agents with path policies](https://www.slivingdoc.dev/docs/guides/path-policies.md): Read-only paths, writable paths, how the two compose by longest match, what agents are told, and what a refusal looks like.
- [Resolve conflicts](https://www.slivingdoc.dev/docs/guides/conflicts.md): When a commit conflicts, what the markers and the structured error look like, how to resolve them, and why a lost race is not a conflict.

## Concepts
- [How it works](https://www.slivingdoc.dev/docs/concepts/how-it-works.md): One notebook cycle in six steps — pull, edit, commit, race, conflict, checkpoint — and the Git and S3 machinery behind each of them.
- [Storage model](https://www.slivingdoc.dev/docs/concepts/storage-model.md): What slivingdoc keeps in the bucket — the current manifest, immutable packs, conditional replacement, pack integrity, checkpoints, retention, and cleanup.
- [Guarantees and limits](https://www.slivingdoc.dev/docs/concepts/guarantees.md): What slivingdoc guarantees, what stays the operator's job, how it behaves at each failure point, the notebook content rules, path security, and the credentials boundary.

## Reference
- [CLI](https://www.slivingdoc.dev/docs/reference/cli.md): Every subcommand and alias, how a notebook path resolves, exit behaviour, and the exact grammar of the success and error reports, their trailers, and their colour.
- [MCP tools](https://www.slivingdoc.dev/docs/reference/mcp-tools.md): The two tools an agent sees — their inputs, the structured success result, the structured error, the server instructions, and the stdio transport.
- [Configuration](https://www.slivingdoc.dev/docs/reference/configuration.md): Every flag, environment variable, and default, with precedence rules and the session-directory and shared-cache notes.
- [Errors](https://www.slivingdoc.dev/docs/reference/errors.md): Every error code and every reason under it, with its meaning, its action, whether a retry helps, what to do next, the file reasons, and the startup refusals.
- [S3 requirements](https://www.slivingdoc.dev/docs/reference/s3.md): The exact object and bucket permissions, the startup compatibility probe and its three conditional-write guarantees, custom endpoints and path style, and what is not required.
- [Logging and profiling](https://www.slivingdoc.dev/docs/reference/logging.md): The LOG_LEVEL grammar and its four modules, timestamps, the stderr-only rule, NO_COLOR, and the three artifacts DEBUG_PERF captures.

## Optional
- [Versioning policy](https://www.slivingdoc.dev/docs/project/versioning.md): What a slivingdoc release contains and how it is tagged, what is stable across releases, and how this documentation is versioned and archived.
- [Changelog](https://www.slivingdoc.dev/docs/project/changelog.md): User-visible changes to this documentation, listed per docs version, and where to find the tool's own release notes.