{"id":43250038,"url":"https://github.com/akkyie/xcdoc","last_synced_at":"2026-02-01T12:57:02.899Z","repository":{"id":328616386,"uuid":"1111520605","full_name":"akkyie/xcdoc","owner":"akkyie","description":"A fully offline command-line explorer for Xcode documentation.","archived":false,"fork":false,"pushed_at":"2025-12-14T10:10:48.000Z","size":31,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-16T13:46:55.543Z","etag":null,"topics":["documentation","swift","xcode"],"latest_commit_sha":null,"homepage":"","language":"Swift","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/akkyie.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":null,"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":"2025-12-07T05:16:18.000Z","updated_at":"2025-12-15T02:14:27.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/akkyie/xcdoc","commit_stats":null,"previous_names":["akkyie/xcdoc"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/akkyie/xcdoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akkyie%2Fxcdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akkyie%2Fxcdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akkyie%2Fxcdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akkyie%2Fxcdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akkyie","download_url":"https://codeload.github.com/akkyie/xcdoc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akkyie%2Fxcdoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28978506,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-01T12:13:08.691Z","status":"ssl_error","status_checked_at":"2026-02-01T12:13:08.356Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["documentation","swift","xcode"],"created_at":"2026-02-01T12:57:01.527Z","updated_at":"2026-02-01T12:57:02.893Z","avatar_url":"https://github.com/akkyie.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# xcdoc\n\nCommand-line explorer for the documentation included with Xcode. `xcdoc` lets you list the documentation hierarchy, search symbols instantly, and render any article as Markdown, all without launching Xcode.\n\n`xcdoc` works fully offline and read-only on the Xcode installed on your machine.\n\n## Requirements\n- macOS 13 or later\n- Xcode 15 or later\n\nThe Xcode version used by `xcdoc` is determined by `xcode-select -p`.\nYou can change it with `xcode-select -s path/to/Xcode.app`, or override it by setting the `DEVELOPER_DIR` environment variable when running a command:\n\n```sh\nDEVELOPER_DIR=/Applications/Xcode-26.0.0.app/Contents/Developer xcdoc search liquid glass\n```\n\n`xcdoc` relies on Xcode's internal formats and may (likely will) break with future Xcode releases.\n\n## Installation\n```bash\ngit clone https://github.com/akkyie/xcdoc.git\ncd xcdoc\nswift build -c release\ncp .build/release/xcdoc /usr/local/bin # or anywhere in the $PATH\n```\n\n### [Mint](https://github.com/yonaskolb/Mint)\n```bash\nmint install akkyie/xcdoc\n```\n\n## Usage\n\n### List categories\nShows the documentation hierarchy.\n```bash\n$ xcdoc list\n```\n\n### Search keywords\nFull-text search across Swift, Objective-C, and other documents (REST APIs, JS frameworks, etc.) using the offline index files.\n\n```bash\n$ xcdoc search String\n\n# You can filter by a language (--swift, --objc, --other)\n$ xcdoc search --swift View\n\n# You can pass multiple keywords, including symbols\n$ xcdoc search String +\n$ xcdoc search app life cycle\n```\n\n### Show an article as Markdown\nAccepts a documentation path found via `xcdoc list` or `xcdoc search`.\n```bash\n$ xcdoc show /documentation/uikit/uiview\n\n# You can specify the language to show (--swift, --objc, --other)\n$ xcdoc show --objc /documentation/uikit/uiview\n```\n\n## Development\n- Build: `swift build`\n- Run: `swift run xcdoc \u003ccommand\u003e`\n- Tests: `swift test`\n\n## Disclaimer\n\n- `xcdoc` runs locally against the documentation files already installed with your copy of Xcode; it does not ship or redistribute any Apple documentation or data files.\n- Implementation is based solely on observations of on-disk data layouts and published SwiftDocC APIs; no Apple executables are reverse-engineered.\n- Generated Markdown is for personal/internal use only; do not republish Apple documentation extracted with this tool. Ensure your usage complies with Apple’s terms and applicable laws.\n- This project is an independent open-source tool and is not authorized, sponsored, or otherwise approved by Apple Inc.\n- Swift®, Xcode®, and macOS® are trademarks of Apple Inc.\n\n## License\n\nxcdoc is available under the MIT License. See `LICENSE` for details.\n\nNote: All output generated by this tool remains the copyrighted material of Apple Inc. and is not covered by this license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakkyie%2Fxcdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakkyie%2Fxcdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakkyie%2Fxcdoc/lists"}