# Atlas

> Two boilerplates: composable Bun/TypeScript packages for APIs, full-stack applications, command-line tools, retrieval, and tool-using agents; and a Rust workspace on gpui and guise for native desktop applications.

Atlas installs as `@wess/atlas`. Public imports use `@wess/atlas/<package>`. The shorter
`@atlas/<package>` spelling requires the optional path aliases documented in the project README.

When generating Atlas code:

- Read the agent guide, then only the package references required by the task.
- Use functions and immutable data; do not introduce classes or mutate inputs.
- Prefer Bun and Web APIs over compatibility packages.
- Treat an export as unavailable unless it appears in a canonical package reference or the API index.
- Run `bun run check`, `bun run typecheck`, and `bun test` before declaring repository work complete.

## Start here

- [Agent guide](https://wess.io/atlas/docs/agents/index.md): Grounding order, import rules, package selection, MCP safety, context budgets, and verification.
- [Quick start](https://wess.io/atlas/docs/quickstart/index.md): Build an authenticated application with storage and administration.
- [API reference](https://wess.io/atlas/docs/api/index.md): Condensed cross-package exports, types, and signatures.
- [Documentation map](https://wess.io/atlas/docs/index.md): Every guide and package reference.
- [Field survey](https://wess.io/atlas/index.md): The site's branching entry point; each numbered section ends in a concrete stack, command, and code.

## Package references

- [config](https://wess.io/atlas/docs/config/index.md): Typed environment variables through `defineConfig` and `env`.
- [db](https://wess.io/atlas/docs/db/index.md): Query building, schemas, changesets, and database drivers.
- [migrate](https://wess.io/atlas/docs/migrate/index.md): Timestamped migrations and schema diffing.
- [server](https://wess.io/atlas/docs/server/index.md): Pipe-based HTTP, typed routes, WebSockets, and server-sent events.
- [edge](https://wess.io/atlas/docs/edge/index.md): TLS-terminating reverse proxy.
- [auth](https://wess.io/atlas/docs/auth/index.md): Passwords, tokens, sessions, authentication flows, and social sign-in.
- [security](https://wess.io/atlas/docs/security/index.md): Headers, rate limits, audit logs, TOTP, and revocable sessions.
- [oauth](https://wess.io/atlas/docs/oauth/index.md): OAuth 2.1 authorization server.
- [sso](https://wess.io/atlas/docs/sso/index.md): OIDC relying party.
- [email](https://wess.io/atlas/docs/email/index.md): Provider-neutral delivery and account templates.
- [share](https://wess.io/atlas/docs/share/index.md): Share URLs and server-side share-by-email.
- [storage](https://wess.io/atlas/docs/storage/index.md): S3-compatible object operations and presigned URLs.
- [cache](https://wess.io/atlas/docs/cache/index.md): Redis caching and cache-aside helpers.
- [request](https://wess.io/atlas/docs/request/index.md): Fetch client, retries, interceptors, and provider presets.
- [cli](https://wess.io/atlas/docs/cli/index.md): Commands, scaffolding, documentation lookup, and process management.
- [ui](https://wess.io/atlas/docs/ui/index.md): React application blocks.
- [admin](https://wess.io/atlas/docs/admin/index.md): Schema-driven administration.
- [mcp](https://wess.io/atlas/docs/mcp/index.md): Documentation access and runtime introspection over MCP.
- [ai](https://wess.io/atlas/docs/ai/index.md): Chat, embeddings, retrieval, streaming, and tool-use loops.

## Desktop

- [Desktop architecture](https://wess.io/atlas/docs/desktop/architecture/index.md): Crate layering, the tokio bridge, state scopes, and the store.
- [Desktop scaffolding](https://wess.io/atlas/docs/desktop/scaffolding/index.md): The scaffolding script, the three templates, and renaming an application.
- [Desktop packaging](https://wess.io/atlas/docs/desktop/packaging/index.md): macOS, Linux, and Windows artifacts and where each comes from.
- [Desktop releases](https://wess.io/atlas/docs/desktop/release/index.md): Signing, notarization, release cutting, and in-place self-update.
- [Desktop gotchas](https://wess.io/atlas/docs/desktop/gotchas/index.md): gpui and guise traps, each with the symptom that led to it.

## Machine-readable interfaces

- [Complete documentation context](https://wess.io/atlas/llms-full.txt): Combined canonical guides and package references for one-fetch indexing.
- [Search index](https://wess.io/atlas/search.json): Titles, descriptions, source kind, routes, and searchable text.
- [MCP reference](https://wess.io/atlas/docs/mcp/index.md): `docs.list`, `docs.read`, health, and conditional service tools.
- [CLI reference](https://wess.io/atlas/docs/cli/index.md): Local documentation access with `atlas docs [name]`.

## Optional

- [Architecture overview](https://wess.io/atlas/docs/overview/index.md): Package graph, design philosophy, and module boundaries.
- [Cookbook](https://wess.io/atlas/docs/cookbook/index.md): Practical cross-package recipes.
- [Project README](https://wess.io/atlas/docs/readme/index.md): Installation, templates, development, and package inventory.