stack hoogle command¶
Hoogle is a Haskell API search engine.
stack hoogle runs Hoogle. Stack needs
Hoogle version 5 or greater.
Stack will use a Hoogle database (
database.hoo) specific to the project's
source map and the version of GHC, located in a subdirectory of subdirectory
hoogle of Stack's work directory for the project.
hoogleexecutable is found on the
PATH, Stack will try to use it. Otherwise, Stack will try to identify an executable as a build target. If the Hoogle database does not exist, Stack will generate it with
hoogle generate --local.
hoogle generate --localqueries
ghc-pkgand generates links for all packages which have documentation and Hoogle input files (
*.txt) generated. Pass the flag
--no-setupto skip such setup;
the existing Hoogle database is used. Pass the flag
--rebuildto trigger the generation of a new Hoogle database (generated as above); and
hoogleis passed the specified arguments (if any). The arguments are usually the subject of the search. Pass the flag
--serverto first pass
server --local --port 8080before those arguments.
hoogle server --local --port 8080starts a local Hoogle web server, using port 8080, that allows the following of