---
title: ShipDocs Docs
description: Product documentation for ShipDocs — how it works, CLI getting started, security, and free tools. Markdown-first for humans and AI agents.
order: 0
---

# ShipDocs Docs

> Agent-readable product documentation for ShipDocs. Every page here has an HTML route and a Markdown twin.

ShipDocs turns any codebase into searchable, chat-ready documentation. Connect a GitHub or GitLab repo, upload a zip, or push from the CLI. ShipDocs scans the tree, detects components, generates an Overview plus per-component Markdown docs, and grounds AI chat in those docs (answers cite file paths).

**Site:** https://shipdocs.sh  
**Machine index:** https://shipdocs.sh/llms.txt  
**Changelog:** https://shipdocs.sh/changelog.md

## Contents

| Page | HTML | Markdown |
|------|------|----------|
| How ShipDocs works | [/docs/how-it-works](https://shipdocs.sh/docs/how-it-works) | [/docs/how-it-works.md](https://shipdocs.sh/docs/how-it-works.md) |
| CLI / getting started | [/docs/cli](https://shipdocs.sh/docs/cli) | [/docs/cli.md](https://shipdocs.sh/docs/cli.md) |
| Security & encryption | [/docs/security](https://shipdocs.sh/docs/security) | [/docs/security.md](https://shipdocs.sh/docs/security.md) |
| Free tools overview | [/docs/free-tools](https://shipdocs.sh/docs/free-tools) | [/docs/free-tools.md](https://shipdocs.sh/docs/free-tools.md) |

## Quick facts

- **Private and public repos** — GitHub, GitLab, ZIP upload, or CLI. Bitbucket coming soon.
- **Encryption** — AES-256-GCM at rest with per-project keys (envelope encryption). See [Security](https://shipdocs.sh/docs/security.md).
- **No AI training on your code** — zero-retention model API endpoints. Binding product commitment.
- **Free tier** — 2 repos, structured docs, limited AI chat. No credit card required.
- **Free public tools** — no signup; operate on public repo URLs. See [Free tools](https://shipdocs.sh/docs/free-tools.md).

## Related

- [Homepage (Markdown)](https://shipdocs.sh/index.md)
- [Privacy policy](https://shipdocs.sh/privacy)
- [Product changelog](https://shipdocs.sh/changelog.md)
- [Blog](https://shipdocs.sh/blog)