ghc-tags: Utility for generating ctags and etags with GHC API.

[ development, mpl, program ] [ Propose Tags ]

Utility for generating etags (Emacs) and ctags (Vim and other editors) with GHC API for efficient project navigation.

[Skip to Readme]


Manual Flags


Use ghc-lib even when compiling with compatible GHC version.


Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info


Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees


  • No Candidates
Versions [RSS] 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8
Change log
Dependencies aeson (>=, async, attoparsec, base (>=4.17 && <4.20), bytestring, containers, deepseq, directory, filepath, ghc, ghc-boot, ghc-lib (>=9.8 && <9.9), ghc-paths, optparse-applicative, process, stm, temporary, text, time, vector, yaml [details]
License MPL-2.0
Copyright Andrzej Rybczak
Author Andrzej Rybczak
Category Development
Home page
Bug tracker
Source repo head: git clone
Uploaded by arybczak at 2024-01-24T17:59:58Z
Executables ghc-tags
Downloads 917 total (40 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
Last success reported on 2024-01-24 [all 1 reports]

Readme for ghc-tags-1.8

[back to package description]


Build Status Hackage

A command line tool that generates etags (Emacs) and ctags (Vim, VSCode with ctagsx etc.) for efficient code navigation (jump to definition).

Main features:

  • Leverages GHC API to obtain accurate information.
  • Uses multiple CPU cores when processing source files.
  • Supports fast incremental updates.

Supported file extensions:

  • .hs
  • .hs-boot
  • .lhs
  • .x (requires alex)
  • .hsc (requires hsc2hs)


For simple projects, i.e. the ones that don't use C pre-processor in non-trivial ways nor include any C sources it should be enough to execute ghc-tags -e (for etags) or ghc-tags -c (for ctags) in the root directory of the project.

For more complicated projects you need to create the configuration file (ghc-tags.yaml by default). It can contain the following keys:

  • source_paths - a list of paths for ghc-tags to process. Directories are traversed recursively.
  • exclude_paths - a list of paths for ghc-tags to exclude from processing.
  • language - the flavour of Haskell, either Haskell98 or Haskell2010.
  • extensions - a list of GHC language extensions to enable when parsing. Note that GHC needs much less extensions for parsing alone, so you should almost never need to override this.
  • cpp_includes - include paths for the C pre-processor.
  • cpp_options - other options for the C pre-processor, e.g. defines (usually undefined MIN_VERSION_x macros will go here).

If any of these keys is not specified, an appropriate default value will be picked instead. You can inspect the defaults by executing ghc-tags --default.

Note: it is possible to specify multiple project configurations in the configuration file by separating them with ---. For example, here is a configuration for GHC on Linux (compiler, utils and base):

- compiler

- _build/stage1/compiler/build
- compiler
- includes/dist-derivedconstants/header


- libraries/base

- libraries/base/GHC/Conc/POSIX/Const.hsc
- libraries/base/GHC/Event/Windows.hsc
- libraries/base/GHC/Event/Windows/ConsoleEvent.hsc
- libraries/base/GHC/Event/Windows/FFI.hsc
- libraries/base/GHC/IO/Windows/Handle.hsc
- libraries/base/System/CPUTime/Windows.hsc
- libraries/base/tests

- _build/stage1/libraries/base/build/include
- includes
- libraries/base/include


- libraries/ghc-bignum

- libraries/ghc-bignum/src/GHC/Num/Backend/Selected.hs

- libraries/ghc-bignum/include


- libraries/ghc-boot
- libraries/ghc-boot-th
- libraries/ghc-compact
- libraries/ghc-heap
- libraries/ghc-prim

- libraries/ghc-compact/tests
- libraries/ghc-heap/tests
- libraries/ghc-prim/tests


Thanks to Marcin Szamotulski for his work on ghc-tags-plugin ghc-tags is based on.