{"id":30713931,"url":"https://github.com/ebonsignori/gh-search-docs","last_synced_at":"2025-09-03T04:09:30.986Z","repository":{"id":301803635,"uuid":"1010355734","full_name":"Ebonsignori/gh-search-docs","owner":"Ebonsignori","description":"A `gh` CLI extension for searching GitHub Docs from your terminal.","archived":false,"fork":false,"pushed_at":"2025-08-27T02:34:20.000Z","size":617,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-27T10:59:53.043Z","etag":null,"topics":["cli","gh-extension","search"],"latest_commit_sha":null,"homepage":"","language":"Go","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/Ebonsignori.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}},"created_at":"2025-06-28T22:29:35.000Z","updated_at":"2025-08-27T02:34:23.000Z","dependencies_parsed_at":"2025-08-05T04:15:08.914Z","dependency_job_id":"a62e7706-46d6-46c2-9ebd-5cb5966403ec","html_url":"https://github.com/Ebonsignori/gh-search-docs","commit_stats":null,"previous_names":["ebonsignori/gh-search-docs"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/Ebonsignori/gh-search-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ebonsignori%2Fgh-search-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ebonsignori%2Fgh-search-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ebonsignori%2Fgh-search-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ebonsignori%2Fgh-search-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ebonsignori","download_url":"https://codeload.github.com/Ebonsignori/gh-search-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ebonsignori%2Fgh-search-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273387408,"owners_count":25096361,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"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":["cli","gh-extension","search"],"created_at":"2025-09-03T04:09:29.444Z","updated_at":"2025-09-03T04:09:30.965Z","avatar_url":"https://github.com/Ebonsignori.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Search (GitHub) Docs CLI\n\n[![Test and Lint](https://github.com/Ebonsignori/gh-search-docs/actions/workflows/test-and-lint.yml/badge.svg)](https://github.com/Ebonsignori/gh-search-docs/actions/workflows/test-and-lint.yml)\n\nA [CLI Extension](https://docs.github.com/en/github-cli/github-cli/using-github-cli-extensions) for the [GitHub CLI](https://cli.github.com/) that lets you search the GitHub documentation using the official GitHub documentation search API.\n\nSearch results are returned from the search API provided by [docs.github.com](https://docs.github.com/en).\n\n![Demonstration of using `gh search-docs` to ask \"ssh key\" and getting 5 results.](./docs/demo.png)\n\n## Installation\n\nInstall this extension using the GitHub CLI:\n\n```bash\ngh extension install ebonsignori/gh-search-docs\n```\n\n### Prerequisites\n\nYou'll need the [GitHub CLI](https://cli.github.com/) installed first:\n- macOS: `brew install gh`\n- Windows: `winget install GitHub.cli`\n- Linux: See [installation instructions](https://github.com/cli/cli#installation)\n\n## Usage\n\n```bash\ngh search-docs [flags] \u003cquery\u003e\n```\n\n### Examples\n\nSearch for documentation:\n```bash\ngh search-docs \"pull request\"\n```\n\nSearch with specific parameters:\n```bash\ngh search-docs --size 5 --highlights title,content \"GitHub Actions\"\n```\n\nSearch Enterprise Server documentation:\n```bash\ngh search-docs --version enterprise-server@3.17 \"SAML configuration\"\n```\n\nGet results in plain text format:\n```bash\ngh search-docs --plain \"API authentication\"\n```\n\nGet results in JSON format:\n```bash\ngh search-docs --format json \"API authentication\"\n```\n\nSearch with additional includes:\n```bash\ngh search-docs --include intro,headings \"webhook events\"\n```\n\nPaginate through results:\n```bash\ngh search-docs --page 2 --size 20 \"Git workflow\"\n```\n\n## Flags\n\n| Flag | Description |\n|------|-------------|\n| `--query` | Search query (can also be provided as positional argument) |\n| `--size` | Number of results to return (max: 50, default: 5) |\n| `--version` | Docs version (`free-pro-team`, `enterprise-cloud`, or `enterprise-server@\u003c3.13-3.17\u003e`) |\n| `--language` | Language code (default: en) |\n| `--page` | Page number for pagination |\n| `--sort` | Sort order |\n| `--highlights` | Highlight options (can be used multiple times): `title`, `content`, `content_explicit`, `term` |\n| `--include` | Additional includes (can be used multiple times): `intro`, `headings`, `toplevel` |\n| `--toplevel` | Toplevel filter (can be used multiple times) |\n| `--aggregate` | Aggregate options (can be used multiple times) |\n| `--debug` | Show raw JSON response from the API |\n| `--format` | Output format: `pretty` (default), `plain`, `json` |\n| `--plain` | Disable pretty rendering (use plain text output) |\n| `--list-versions` | List supported GitHub Enterprise Server versions |\n\n## More examples\n\n### Finding specific topics:\n```bash\ngh search-docs \"repository settings\"\ngh search-docs \"branch protection rules\"\ngh search-docs \"GitHub Apps authentication\"\n```\n\n### Enterprise-specific searches:\n```bash\ngh search-docs --version enterprise-server@3.17 \"LDAP configuration\"\ngh search-docs --version enterprise-cloud \"SAML SSO\"\n```\n\n### Detailed searches with highlights:\n```bash\ngh search-docs --highlights title,content --include intro,headings \"webhook payload\"\n```\n\n### Paginated browsing:\n```bash\ngh search-docs --size 5 \"API\" --page 1\ngh search-docs --size 5 \"API\" --page 2\n```\n\n## Development\n\nPlease see [development docs](./DEVELOPMENT.md).\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Febonsignori%2Fgh-search-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Febonsignori%2Fgh-search-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Febonsignori%2Fgh-search-docs/lists"}