Reference

fish_indent(1)

indenter and prettifier

NAME

fish_indent - indenter and prettifier

SYNOPSIS

fish_indent [OPTIONS] [FILE ...]

DESCRIPTION

fish_indent is used to indent a piece of fish code. fish_indent reads commands from standard input or the given filenames and outputs them to standard output or a specified file (if -w is given).

The following options are available:

-w or --write

Indents a specified file and immediately writes to that file.

-i or --no-indent

Do not indent commands; only reformat to one job per line.

--only-indent

Do not reformat, only indent each line.

--only-unindent

Do not reformat, only unindent each line.

-c or --check

Do not indent, only return 0 if the code is already indented as fish_indent would, the number of failed files otherwise. Also print the failed filenames if not reading from standard input.

-v or --version

Displays the current fish version and then exits.

--ansi

Colorizes the output using ANSI escape sequences using the colors defined in the environment (such as fish_color_command <#envvar-fish_color_command>).

--html

Outputs HTML, which supports syntax highlighting if the appropriate CSS is defined. The CSS class names are the same as the variable names, such as fish_color_command.

--dump-parse-tree

Dumps information about the parsed statements to standard error. This is likely to be of interest only to people working on the fish source code.

-h or --help

Displays help about using this command.

Copyright

fish-shell developers

History

--ansi since Debian 12 (Bookworm); --check since Debian 12 (Bookworm); --dump-parse-tree since Debian 12 (Bookworm); --help since Debian 12 (Bookworm); --html since Debian 12 (Bookworm); --no-indent since Debian 12 (Bookworm); --only-indent since Debian 13 (Trixie); --only-unindent since Debian 13 (Trixie); --version since Debian 12 (Bookworm); --write since Debian 12 (Bookworm); -c since Debian 12 (Bookworm); -h since Debian 12 (Bookworm); -i since Debian 12 (Bookworm); -v since Debian 12 (Bookworm); -w since Debian 12 (Bookworm).

--debug until Debian 13 (Trixie); --debug-output until Debian 13 (Trixie); -d until Debian 13 (Trixie); -o until Debian 13 (Trixie).