dfhack/docs/builtins/ls.rst

39 lines
1.2 KiB
ReStructuredText

2022-07-18 11:58:35 -06:00
ls
==
Tags: `tag/system`
:dfhack-keybind:`ls`
2022-07-18 11:58:35 -06:00
:index:`List available DFHack commands. <ls; List available DFHack commands.>`
In order to group related commands, each command is associated with a list of
tags. You can filter the listed commands by a tag or a substring of the
command name. Can also be invoked as ``dir``.
2022-07-18 11:58:35 -06:00
Usage:
- ``ls [<options>]``
Lists all available commands and the tags associated with them.
2022-07-18 11:58:35 -06:00
- ``ls <tag> [<options>]``
Shows only commands that have the given tag. Use the `tags` command to see
the list of available tags.
2022-07-18 11:58:35 -06:00
- ``ls <string> [<options>]``
Shows commands that include the given string. E.g. ``ls quick`` will show
all the commands with "quick" in their names. If the string is also the
name of a tag, then it will be interpreted as a tag name.
2022-07-18 11:58:35 -06:00
You can also pass some optional parameters to change how ``ls`` behaves:
- ``--notags``
Don't print out the tags associated with each command.
2022-07-18 11:58:35 -06:00
- ``--dev``
Include commands intended for developers and modders.
2022-07-18 11:58:35 -06:00
Examples
--------
2022-07-18 11:58:35 -06:00
- ``ls adventure``
Lists all commands with the ``adventure`` tag.
2022-07-18 11:58:35 -06:00
- ``ls --dev trigger``
Lists all commands, including developer and modding commands, that match the
substring "trigger"