{"id":48980794,"url":"https://github.com/g-cqd/apple-docs","last_synced_at":"2026-06-10T21:01:11.938Z","repository":{"id":350968120,"uuid":"1208915774","full_name":"g-cqd/apple-docs","owner":"g-cqd","description":"Local Apple developer documentation corpus — CLI, MCP server, and static site generator. 10 sources, tiered search, offline-first.","archived":false,"fork":false,"pushed_at":"2026-06-07T08:55:39.000Z","size":3197,"stargazers_count":12,"open_issues_count":1,"forks_count":2,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-07T10:24:46.576Z","etag":null,"topics":["apple","bun","cli","documentation","mcp","swift"],"latest_commit_sha":null,"homepage":"https://apple-docs.everest.mt","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/g-cqd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-12T22:52:57.000Z","updated_at":"2026-06-07T08:55:43.000Z","dependencies_parsed_at":"2026-04-26T09:02:14.753Z","dependency_job_id":null,"html_url":"https://github.com/g-cqd/apple-docs","commit_stats":null,"previous_names":["g-cqd/apple-docs"],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/g-cqd/apple-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g-cqd%2Fapple-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g-cqd%2Fapple-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g-cqd%2Fapple-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g-cqd%2Fapple-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/g-cqd","download_url":"https://codeload.github.com/g-cqd/apple-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g-cqd%2Fapple-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34170161,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-10T02:00:07.152Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apple","bun","cli","documentation","mcp","swift"],"created_at":"2026-04-18T11:16:53.685Z","updated_at":"2026-06-10T21:01:11.922Z","avatar_url":"https://github.com/g-cqd.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# apple-docs\n\n**All of Apple's developer documentation, on your machine.** Search it from\nthe terminal, browse it in your browser, and plug it into Claude, Codex,\nCursor, or any other MCP client — fully offline once installed.\n\nOne indexed corpus (~353,000 documents), three ways in:\n\n- **CLI** — `apple-docs search \"NavigationStack\"` answers in milliseconds.\n- **MCP server** — your AI assistant cites real Apple docs instead of guessing.\n- **Local website** — browse and full-text search in the browser, or publish\n  it as a static site.\n\nIt covers Apple's API reference (DocC), Human Interface Guidelines, App Store\nReview Guidelines, Swift Evolution, the Swift book, Swift.org, WWDC sessions\n(1997–2026, transcripts included), Apple sample code, archived documentation,\na Swift package catalog, every SF Symbol, and Apple's fonts.\n\n## Quick start\n\nYou need [Bun](https://bun.sh) 1.1+.\n\n```bash\ngit clone https://github.com/g-cqd/apple-docs.git\ncd apple-docs\nbun run dev:setup    # install dependencies + link the CLI\napple-docs setup     # download + install the latest snapshot\n```\n\n`setup` downloads one verified archive (**1.62 GB**) and installs it in a few\nminutes. After that, everything works offline:\n\n```bash\napple-docs search \"NavigationStack\"\napple-docs search \"how do I record audio in the background\"\napple-docs read swiftui/view\n```\n\nSearch takes both forms: exact symbol names and plain-English questions\n(a local semantic index is built during setup — no cloud, no API key).\n\n### Pick a disk/speed tradeoff (optional)\n\n`setup` asks which storage profile you want; flags skip the prompt:\n\n| | Command | Disk | Best for |\n| --- | --- | --- | --- |\n| Smallest | `apple-docs setup --compact` | ~3 GB | laptops, CI |\n| Default | `apple-docs setup` | ~5.5 GB | most setups |\n| Fastest reads | `apple-docs setup --prebuilt` | ~8.6 GB | serving the website |\n\nAll three contain the full corpus and search identically — they only trade\ndisk for read speed. Details and how to switch later:\n[`docs/configuration.md`](docs/configuration.md#storage-profiles).\n\n\u003e Prefer a standalone binary or a production self-host? See\n\u003e [`docs/installing.md`](docs/installing.md).\n\n## Everyday commands\n\n```bash\n# Search — filters beat clever queries\napple-docs search \"Swift Testing\" --source wwdc --year 2024\napple-docs search \"privacy\" --framework app-store-review\napple-docs search \"scroll\" --kind article --platform visionos\n\n# Read a page (or just one section of it)\napple-docs read swiftui/view\napple-docs read View --framework swiftui\napple-docs read swiftui/view --section Overview\n\n# Explore\napple-docs frameworks                  # every documentation root\napple-docs browse swiftui              # a framework's pages\napple-docs browse wwdc                 # WWDC years with session counts\napple-docs browse wwdc --year 2025     # one year's sessions\napple-docs status                      # corpus freshness + counts\n```\n\n`apple-docs --help` and `apple-docs \u003ccommand\u003e --help` are the exhaustive\nreference.\n\n## Use it from your AI tools (MCP)\n\n```bash\napple-docs mcp install            # prints ready-to-paste client config\napple-docs mcp start              # stdio server\napple-docs mcp serve --port 3031  # Streamable HTTP server\n```\n\nNine read-only tools: `search_docs`, `read_doc`, `list_frameworks`, `browse`,\n`list_taxonomy`, `search_sf_symbols`, `list_apple_fonts`, `render_sf_symbol`,\n`render_font_text` — plus resources for docs, frameworks, SF Symbol renders,\nand font files.\n\nThe tool surface is deliberately **context-cheap**: definitions cost ~2.2k\ntokens total (about a quarter of a typical multi-tool MCP server), responses\nare compact JSON with pagination built in, and a CI budget test keeps it that\nway. Your context window stays available for actual work.\n\nHTTP mode has no built-in auth — keep it on loopback unless a reverse proxy\nor tunnel handles access control.\n\n### Public instance\n\nA best-effort public deployment (no uptime SLA; self-host for production):\n\n```bash\nclaude mcp add -s user --transport http apple-docs https://apple-docs-mcp.everest.mt/mcp\ncodex mcp add apple-docs -- bunx mcp-remote https://apple-docs-mcp.everest.mt/mcp\n```\n\n## Local website\n\n```bash\napple-docs web serve                  # http://127.0.0.1:3000\napple-docs web build --out dist/web   # static site\n```\n\nThe server is agent-friendly out of the box: append `.md` to any doc URL for\nMarkdown (`/docs/swiftui/view.md`), and discovery endpoints are served at\n`/robots.txt`, `/.well-known/api-catalog` (RFC 9727), and\n`/.well-known/mcp/server-card.json`. Deployment recipes:\n`apple-docs web deploy \u003cgithub-pages|cloudflare|vercel|netlify\u003e` and\n[`docs/self-hosting.md`](docs/self-hosting.md).\n\n## Keeping it fresh\n\nSnapshots are rebuilt weekly by CI. To update, re-run:\n\n```bash\napple-docs setup --force\n```\n\nRunning a newer macOS than CI? `apple-docs setup --beta --force` opts into\nprerelease snapshots built on developer machines, which carry SF Symbols the\nstable CI builds can't produce yet\n([details](docs/configuration.md#beta-channel)).\n\nOr skip snapshots entirely and crawl Apple's docs yourself:\n\n```bash\napple-docs sync          # resumable, idempotent refresh\napple-docs sync --full   # clean rebuild\n```\n\n`sync` also merges Xcode's offline documentation asset when one is available\nlocally (USRs and a few thousand pages the public crawl can't see) — CI does\nthis for every published snapshot, so installed snapshots already include it.\n\nBuild your own portable snapshot with `apple-docs snapshot build --out dist`,\ninstall it with `apple-docs setup --archive \u003cpath\u003e`.\n\n## What's in the corpus\n\n| Source | Coverage |\n| --- | --- |\n| `apple-docc` | API reference: frameworks, technologies, release notes |\n| `hig` | Human Interface Guidelines |\n| `guidelines` | App Store Review Guidelines |\n| `swift-evolution` | Swift Evolution proposals |\n| `swift-book` | The Swift Programming Language |\n| `swift-docc` | Swift toolchain docs (compiler, SwiftPM, migration guides) |\n| `swift-org` | Swift.org documentation and articles |\n| `apple-archive` | Archived Apple developer documentation |\n| `wwdc` | WWDC sessions with transcripts, browsable by year |\n| `sample-code` | Apple sample code catalog |\n| `packages` | Swift package catalog with README content |\n\n## Development\n\n```bash\nbun run ci                          # lint + typecheck + tests\nbun run audit                       # + unused code, duplication, coverage\nbun scripts/verify-profiles.mjs     # full integration matrix: installs every\n                                    # storage profile from the latest snapshot\n                                    # and exercises CLI + web + MCP against each\n```\n\nMore docs: [architecture](docs/architecture.md) ·\n[configuration](docs/configuration.md) · [installing](docs/installing.md) ·\n[self-hosting](docs/self-hosting.md) · [performance](docs/perf/index.md) ·\n[security](docs/security.md) · [index](docs/README.md)\n\n## License\n\n[MIT](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fg-cqd%2Fapple-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fg-cqd%2Fapple-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fg-cqd%2Fapple-docs/lists"}