Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lazamar/haskell-docs-cli
Browse Hackage from the terminal
https://github.com/lazamar/haskell-docs-cli
cli command-line haskell
Last synced: 2 days ago
JSON representation
Browse Hackage from the terminal
- Host: GitHub
- URL: https://github.com/lazamar/haskell-docs-cli
- Owner: lazamar
- License: bsd-3-clause
- Created: 2021-08-27T21:52:27.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T17:17:45.000Z (22 days ago)
- Last Synced: 2024-10-28T17:13:15.962Z (16 days ago)
- Topics: cli, command-line, haskell
- Language: Haskell
- Homepage:
- Size: 6.53 MB
- Stars: 92
- Watchers: 5
- Forks: 11
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- License: LICENSE
Awesome Lists containing this project
README
# haskell-docs-cli
This package allows you to perform [Hoogle](https://hoogle.haskell.org/) searches and to
navigate [Hackage](https://hackage.haskell.org/) documentation and source code from the command
line.
Staying in the command line avoids switching to and from the browser, makes it
easier to seach a documentation page, jumping through its content, and to view
the source code of libraries.
Read more about the rationale in the [blog post](https://lazamar.github.io/haskell-documentation-in-the-command-line/).
## Installation
### Install from Hackage
Installing the `haskell-docs-cli` package makes the `hdc` binary available.
```
$ cabal install haskell-docs-cli
$ hdc
---- haskell-docs-cli ----------------------------------------------------------
Say :help for help and :quit to exit
--------------------------------------------------------------------------------
>
```
### Install from source
Download the project and run `stack install`.
It will make the `hdc` executable available in your path.
```
git clone https://github.com/lazamar/haskell-docs-cli.git
cd haskell-docs-cli
stack install
```
## Functionalities
Demo of all commands
[](https://asciinema.org/a/436972)
### Search using Hoogle
Just like in Hoogle, just type a function name or
signature to search for matching entries in all of Hackage.
You can select an option by typing its number or by searching for its name with
`/`.
Press `Enter` to view the contents of the current context (search, module or
package) again. If in a search context, pressing `Enter` you will see the
results again. The current context is displayed in the line above the prompt.
### View documentation
Use `:mdocumentation` (or `md` for short) to view documentation about a module.
It will show you the documentation for the first module to match a Hoogle search
for the term you type. As this is a Hoogle search, you can use `+`
to specify the package if you want, like in Hoogle itself.
Use `:pdocumentation` (or `pd` for short) to view documentation about a package.
### View interfaces
Use `:minterface` (or `:mi`) to view all functions, types, aliases and classes
exported by a module.
Use `pinterface` (or `:pi`) to view the modules contained in a package.
You can navigate further into the options by selecting them by number, or by
name with `/`.
### Navigate the source code
You can view the source code of a search result with `:src ` where
the selector is either the result number or a filter term prefixed by `/`.
If you type `:src` and a search term, `haskell-doc-cli` will load the source of
the first Hoogle result that is not a module or package.
## Contributing
Contributions are very welcome. Here are some things that would be nice to have:
- Fix more edge cases
- Windows compatibility