{"id":15713618,"url":"https://github.com/devnote-dev/docr","last_synced_at":"2025-06-12T11:33:28.905Z","repository":{"id":158440165,"uuid":"622019921","full_name":"devnote-dev/docr","owner":"devnote-dev","description":"A CLI tool for searching Crystal documentation","archived":false,"fork":false,"pushed_at":"2024-10-22T09:11:25.000Z","size":1657,"stargazers_count":17,"open_issues_count":2,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-05T21:50:12.173Z","etag":null,"topics":["cli","command-line","crystal","crystal-lang","docs","documentation-tool","terminal","terminal-ui"],"latest_commit_sha":null,"homepage":"","language":"Crystal","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devnote-dev.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}},"created_at":"2023-03-31T22:52:44.000Z","updated_at":"2025-05-01T03:48:32.000Z","dependencies_parsed_at":"2024-09-11T01:30:53.297Z","dependency_job_id":"22f80fef-1237-41bb-8067-f771ef025440","html_url":"https://github.com/devnote-dev/docr","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/devnote-dev/docr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devnote-dev%2Fdocr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devnote-dev%2Fdocr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devnote-dev%2Fdocr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devnote-dev%2Fdocr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devnote-dev","download_url":"https://codeload.github.com/devnote-dev/docr/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devnote-dev%2Fdocr/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259456048,"owners_count":22860478,"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","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","command-line","crystal","crystal-lang","docs","documentation-tool","terminal","terminal-ui"],"created_at":"2024-10-03T21:32:31.425Z","updated_at":"2025-06-12T11:33:28.521Z","avatar_url":"https://github.com/devnote-dev.png","language":"Crystal","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp\u003e\n  \u003ch3 align=\"center\"\u003edocr | doc-cr | /ˈdɒ·kur/\u003c/h3\u003e\n  \u003cp align=\"center\"\u003eA CLI tool for searching Crystal documentation\u003c/p\u003e\n\u003c/p\u003e\n\n## Installation\n\nSee the [releases page](https://github.com/devnote-dev/docr/releases/latest) for available binaries.\n\n### Windows\n\n```\nscoop bucket add docr https://github.com/devnote-dev/docr\nscoop install docr\n```\n\n### From Source\n\nCrystal v1.10.0 or above is required to build Docr.\n\n```sh\ngit clone https://github.com/devnote-dev/docr\ncd docr\nshards build\n```\n\n## Usage\n\nBy default Docr comes with no libraries, but you can easily import the standard library documentation using `docr add crystal`. Docr will default to the latest available version, but you can specify the version as a second argument. You can also import shard documentation by specifying the source URL in one of the following formats:\n\n- docr add https://github.com/user/repo\n- docr add github.com/user/repo\n- docr add github:user/repo\n- docr add gh:user/repo\n\nThe following shorthands are supported for sources:\n\n- github: / gh:\n- gitlab: / gl:\n- bitbucket: / bb:\n- codeberg: / cb:\n- srht:\n\n\u003e [!IMPORTANT]\n\u003e Only GitHub, GitLab, BitBucket, Codeberg and Source Hut are supported sources. Bare repositories are not supported.\n\nAfter importing the libraries you want, you can simply lookup or search whatever you want! Use the `docr search` command to search for all types and symbols matching the query, and the `docr info` command to get direct information about a specified type or symbol:\n\n![demo_4](/assets/demo_4.png)\n\nBoth the `info` and `search` commands support Crystal path syntax for queries, meaning the following commands are valid:\n\n- `docr info raise`\n- `docr info ::puts`\n- `docr info JSON.parse`\n- `docr info ::JSON::Any#as_s`\n\nHowever, the following commands _are not_ valid:\n\n- `docr info to_s.nil?`\n- `docr info IO.Memory`\n- `docr info JSON::parse`\n- `docr info JSON#Any.as_s`\n\nTODO: complete 'info' \u0026 'search' headers\n\n## Contributing\n\n1. Fork it (https://github.com/devnote-dev/docr/fork)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n## Contributors\n\n- [Devonte](https://github.com/devnote-dev) - creator and maintainer\n\nThis repository is managed under the Mozilla Public License v2.\n\n© 2023-present devnote-dev\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevnote-dev%2Fdocr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevnote-dev%2Fdocr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevnote-dev%2Fdocr/lists"}