Packages

exdoc_cli

0.1.1

0.1.4 0.1.3 0.1.2 0.1.1

A simple CLI for displaying built-in Elixir docs

HexDocs

Current section

Files

Jump to

Readme 4 Versions 1 Dependency Dependants Files Activity

exdoc_cli README.md

Raw

6 files

lib
- exdoc_cli
  
  help_command.ex
- exdoc_cli.ex
CHANGELOG.md
COPYING
README.md
mix.exs

README.md

# Exdoc CLI

A CLI equivilent to the IEx h/1 helper.

## Installation

Install with `mix escript.install hex exdoc_cli`

Once installed, run `exdoc <Module>`

## Examples
  * exdoc Enum
  * exdoc Enum.flat_map
  * exdoc Enum.reduce/2

![Example Commands](./example.gif)

Search filters

Type any of these into the search box. They can be combined with free text which searches package names and descriptions.

Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT

Wrap values in double quotes to include spaces, e.g. name:"my package".