dfhack/docs/builtins/ls.rst

45 lines
1.3 KiB
ReStructuredText

2022-07-18 11:58:35 -06:00
ls
==
2022-07-18 11:58:35 -06:00
.. dfhack-tool::
:summary: List available DFHack commands.
2022-08-12 00:34:37 -06:00
:tags: dfhack
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
2022-08-17 23:42:02 -06:00
Usage
-----
2022-07-18 11:58:35 -06:00
``ls [<options>]``
Lists all available commands and the tags associated with them.
``ls <tag> [<options>]``
Shows only commands that have the given tag. Use the `tags` command to see
the list of available tags.
``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
Examples
--------
2022-07-18 11:58:35 -06:00
``ls quick``
List all commands that match the substring "quick".
``ls adventure``
List all commands with the ``adventure`` tag.
``ls --dev trigger``
List all commands, including developer and modding commands, that match the
substring "trigger".
Options
-------
``--notags``
Don't print out the tags associated with each command.
``--dev``
Include commands intended for developers and modders.
2022-10-05 14:30:14 -06:00
``--exclude <string>[,<string>...]``
Exclude commands that match any of the given strings.