{"id":18626661,"url":"https://github.com/silbermm/exdoc_cli","last_synced_at":"2026-03-17T20:15:23.425Z","repository":{"id":43684271,"uuid":"443940348","full_name":"silbermm/exdoc_cli","owner":"silbermm","description":"CLI for displaying exdoc","archived":false,"fork":false,"pushed_at":"2024-01-15T15:15:21.000Z","size":28576,"stargazers_count":16,"open_issues_count":2,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-09-17T08:37:52.320Z","etag":null,"topics":["cli","documentation","elixir"],"latest_commit_sha":null,"homepage":"https://hexdocs.pm/exdoc_cli/","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/silbermm.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"COPYING","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":"2022-01-03T04:31:49.000Z","updated_at":"2025-04-09T10:20:12.000Z","dependencies_parsed_at":"2024-11-07T04:40:53.715Z","dependency_job_id":"622118c8-ad97-4450-824f-e779ffcc112c","html_url":"https://github.com/silbermm/exdoc_cli","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/silbermm/exdoc_cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silbermm%2Fexdoc_cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silbermm%2Fexdoc_cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silbermm%2Fexdoc_cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silbermm%2Fexdoc_cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/silbermm","download_url":"https://codeload.github.com/silbermm/exdoc_cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silbermm%2Fexdoc_cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30630379,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-17T17:32:55.572Z","status":"ssl_error","status_checked_at":"2026-03-17T17:32:38.732Z","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":["cli","documentation","elixir"],"created_at":"2024-11-07T04:38:36.105Z","updated_at":"2026-03-17T20:15:23.400Z","avatar_url":"https://github.com/silbermm.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Exdoc CLI\n\n\n![](https://github.com/silbermm/exdoc_cli/workflows/Build%20and%20Test/badge.svg)\n[![Hex.pm](https://img.shields.io/hexpm/v/exdoc_cli?style=flat-square)](https://hexdocs.pm/exdoc_cli/ExdocCLI.html#content)\n\nA CLI equivilent to the IEx h/1 helper.\n\n![Example Commands](https://raw.githubusercontent.com/silbermm/exdoc_cli/main/exdoc_usage.gif)\n\n## Installation\n\nInstall with `mix escript.install hex exdoc_cli`\n\nOnce installed, run `exdoc \u003cModule\u003e`\n\n## Examples\n```bash\n$ exdoc Enum\n$ exdoc Enum.flat_map\n$ exdoc Enum.reduce/2\n```\n\n## View source code\n\nTo view the source code of the module, pass the `--open` flag.\n\n```bash\nexdoc Enum.reduce/2 --open\n```\n\nThis uses the $ELIXIR_EDITOR environment variable and falls back to $EDITOR if the former is not available. See [IEx.Helpers.open/1](https://github.com/elixir-lang/elixir/blob/main/lib/iex/lib/iex/helpers.ex#L251-L294) or just run `exdoc IEx.Helpers.open/1` for more info on setting up your editor.\n\nOn my system, I use [Alacritty](https://alacritty.org/) as my terminal and Vim as my editor. I've setup a tiny little executable script called `vimsh` that opens a terminal and starts vim with the specified file that looks like this:\n```bash\n#!/bin/bash\n\n/usr/bin/alacritty -e vim $@\n```\n\nand my $ELIXIR_EDITOR variable is set as:\n```\nvimsh +__LINE__ __FILE__\n```\n\n## License\nGNU GENERAL PUBLIC LICENSE\nVersion 3, 29 June 2007\n\nCopyright (C) 2022 Matt Silbernagel\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilbermm%2Fexdoc_cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsilbermm%2Fexdoc_cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilbermm%2Fexdoc_cli/lists"}