# Atlas documentation

> Canonical guides and package references for Atlas, for both the web and desktop boilerplates.

## Guides

- [Agent guide](https://wess.io/atlas/docs/agents/index.md): Grounding order, package selection, MCP safety, context budgets, and verification.
- [Architecture overview](https://wess.io/atlas/docs/overview/index.md): The package graph, design philosophy, and the boundaries between modules.
- [Quick start](https://wess.io/atlas/docs/quickstart/index.md): Build an authenticated application with storage and an admin surface.
- [API reference](https://wess.io/atlas/docs/api/index.md): A condensed, cross-package lookup for exports, types, and signatures.
- [Cookbook](https://wess.io/atlas/docs/cookbook/index.md): Practical recipes for common application patterns and edge cases.
- [Project readme](https://wess.io/atlas/docs/readme/index.md): Installation, package inventory, templates, and development commands.

## Desktop

- [Desktop architecture](https://wess.io/atlas/docs/desktop/architecture/index.md): The crate layering, the tokio bridge, state scopes, and the store.
- [Desktop scaffolding](https://wess.io/atlas/docs/desktop/scaffolding/index.md): new.sh, the three templates, renaming an app, and developing Atlas alongside one.
- [Desktop packaging](https://wess.io/atlas/docs/desktop/packaging/index.md): Every artifact an app ships on macOS, Linux, and Windows, and where it comes from.
- [Desktop releases](https://wess.io/atlas/docs/desktop/release/index.md): Signing, notarization, cutting a release, and in-place self-update.
- [Desktop gotchas](https://wess.io/atlas/docs/desktop/gotchas/index.md): The gpui and guise traps, each with the symptom that led to it.

## Package references

- [@wess/atlas/config](https://wess.io/atlas/docs/config/index.md): Typed environment variables and immutable configuration.
- [@wess/atlas/db](https://wess.io/atlas/docs/db/index.md): Query building, schemas, changesets, and Postgres or SQLite drivers.
- [@wess/atlas/server](https://wess.io/atlas/docs/server/index.md): Pipe-based HTTP, typed routes, WebSockets, and server-sent events.
- [@wess/atlas/auth](https://wess.io/atlas/docs/auth/index.md): Passwords, JWTs, sessions, auth flows, and social sign-in.
- [@wess/atlas/security](https://wess.io/atlas/docs/security/index.md): Headers, rate limiting, audit logs, TOTP, and revocable sessions.
- [@wess/atlas/oauth](https://wess.io/atlas/docs/oauth/index.md): An OAuth 2.1 server with PKCE, refresh rotation, and device flow.
- [@wess/atlas/request](https://wess.io/atlas/docs/request/index.md): A fetch client with retries, interceptors, and provider presets.
- [@wess/atlas/storage](https://wess.io/atlas/docs/storage/index.md): S3-compatible object operations and presigned URLs.
- [@wess/atlas/cache](https://wess.io/atlas/docs/cache/index.md): Redis caching, memory stores, TTLs, and cache-aside helpers.
- [@wess/atlas/cli](https://wess.io/atlas/docs/cli/index.md): Commands, scaffolding, documentation lookup, and Foreman.
- [@wess/atlas/ui](https://wess.io/atlas/docs/ui/index.md): React and Mantine blocks for forms, tables, auth, and more.
- [@wess/atlas/admin](https://wess.io/atlas/docs/admin/index.md): Schema-driven CRUD routes and a generated administration UI.
- [@wess/atlas/mcp](https://wess.io/atlas/docs/mcp/index.md): Application introspection and Atlas documentation over MCP.
- [@wess/atlas/ai](https://wess.io/atlas/docs/ai/index.md): Providers, chat, embeddings, RAG, agents, and streaming.
- [@wess/atlas/edge](https://wess.io/atlas/docs/edge/index.md): A TLS reverse proxy with built-in Let's Encrypt automation.
- [@wess/atlas/email](https://wess.io/atlas/docs/email/index.md): Provider-agnostic email delivery and account templates.
- [@wess/atlas/share](https://wess.io/atlas/docs/share/index.md): Social share URLs and server-side share-by-email.
- [@wess/atlas/sso](https://wess.io/atlas/docs/sso/index.md): An OIDC relying party for signing in with an identity provider.
- [@wess/atlas/migrate](https://wess.io/atlas/docs/migrate/index.md): Timestamped SQL migrations and schema-diff generation.