CheatUniversal Ctags Source code indexer
Light · Postcard
102 × 152 mm · PDF
Dark · Postcard
102 × 152 mm · PDF
Ink saver · Postcard
102 × 152 mm · PDF
Light · A4 landscape
297 × 210 mm · PDF
Dark · A4 landscape
297 × 210 mm · PDF
Ink saver · A4 landscape
297 × 210 mm · PDF
Light · A3 landscape
420 × 297 mm · PDF
Dark · A3 landscape
420 × 297 mm · PDF
Ink saver · A3 landscape
420 × 297 mm · PDF
Start here
ctags -RIndex the tree into ./tags
ctags -R src/ lib/
Index chosen directories
ctags -R --exclude=node_modules .
Skip a directory
ctags --list-languages
Supported languages
ctags -x <file>
Print tags, no tags file
ctags -a <file>
Append to existing tags
ctags -R --fields=+n
Add line numbers
ctags -e -RWrite Emacs TAGS
Concepts
- Source files many languages
- tags file name, file, location
- Jump Ctrl+] in Vim
Generate tags
ctags -RIndex current directory recursively
ctags -R <dir>...
Index only these directories
ctags <file>...
Index specific files
ctags -f <tagfile> -R
Write to another file name
ctags -f - <file>
Write tags to stdout
ctags -a <file>
Append instead of overwrite
ctags -L <list>
Read file names from a list
find . -name '*.c' | ctags -L -
Read file names from stdin
ctags --tag-relative=yes
Store paths relative to tags file
ctags --sort=noKeep tags unsorted
Vim's binary search expects sorted tags; use foldcase with
'tagcase'.
ctags --sort=foldcase
Sort ignoring case
ctags --totalsPrint counts when finished
ctags -VVerbose: show what is read
Select files and languages
ctags --exclude=<pattern>
Skip matching files or dirs
ctags --languages=<list>
Only parse these languages
ctags --languages=-<lang>
Disable one language
ctags --languages=+<lang>
Enable one more language
ctags --exclude=@<file>
Read exclude patterns from a file
ctags --exclude-exception=<pattern>
Re-include an excluded path
ctags --list-languages
List supported languages
ctags --list-maps
Show extension to language map
ctags --map-<lang>=+<ext>
Add an extension to a language
ctags --langmap=<lang>:<ext>
Set the extensions of a language
ctags --print-language <file>
Show the parser chosen for a file
ctags -GGuess language from file content
ctags --links=no
Do not follow symlinks
Tag content
ctags --list-kinds=<lang>
List kinds of a language
ctags --kinds-<lang>=+<kinds>
Add kinds, e.g. --kinds-c=+p
ctags --kinds-<lang>=-<kinds>
Drop kinds
ctags --fields=+n
Add line numbers
ctags --fields=+S
Add function signatures
ctags --fields=+l
Add source language
ctags --fields=+K
Show kind as a long name
ctags --fields=*
Enable all fields
ctags --extras=+q
Add qualified names (Class.member)
ctags --extras=+f
Add a tag per file name
ctags --extras=+r
Add reference tags (includes)
ctags --list-fields
List available fields
ctags --list-extras
List available extras
ctags -nLocate by line number, not pattern
ctags --pattern-length-limit=0
Never truncate search patterns
Output formats
ctags -x <file>
Cross-reference table on stdout
ctags --output-format=json
One JSON object per tag
Needs a build with libjansson; check ctags --list-features.
ctags -eEmacs etags format (TAGS)
ctags --output-format=u-ctags
Default format
ctags --list-output-formats
List supported formats
ctags --list-features
List compiled-in features
ctags --versionShow the version
Config files
ctags --options=<path>
Read options from file or directory
ctags --options=NONE
Ignore preloaded config files
Must be the first option.
ctags --options-maybe=<path>
Like --options, no error if missing
~/.ctags.d/*.ctags
Per-user options, one per line
.ctags.d/*.ctags
Per-project options
ctags
--regex-<lang>=/<re>/<name>/<kind>/
Add a regex tag rule
ctags --langdef=<name>
Define a new language
ctags -I <ident>
Ignore a C macro identifier
ctags -D <macro>=<def>
Define a C preprocessor macro
Use in Vim
Ctrl+]Jump to tag under cursor
Ctrl+TJump back up the tag stack
:tag <name>
Jump to a tag by name
g]List matches for tag under cursor
:tselect <name>
Choose among matching tags
:tnext / :tprevNext or previous matching tag
Ctrl+W ]Open tag in a split
:tagsShow the tag stack
vim -t <name>
Start Vim at a tag
:set tags=./tags;,tags
Search parent directories for tags
Recipes
ctags -R \ --exclude=.git --exclude=node_modules \ --exclude=build --exclude='*.min.js' .# one option per line--recurse=yes--exclude=.git--exclude=node_modules--languages=-JSONctags -R --fields=+n .grep -P '^main\t' tagsctags -x --kinds-c=f src/main.cgit ls-files | ctags -L - --fields=+nS# fast index of just what git tracks
