CLI Usage

1
Usage: typstyle [OPTIONS] [INPUT]...
2
3
Arguments:
4
  [INPUT]...  List of files or directories to format [default: stdin]
5
6
Options:
7
  -i, --inplace  Format the file in place
8
      --check    Run in 'check' mode. Exits with 0 if input is formatted correctly. Exits with a non-zero status code if formatting is required
9
      --diff     Run in 'diff' mode. Shows unified diff of what formatting changes would be made. Exits with 0 if input is formatted correctly. Exits with a non-zero status code if formatting is required
10
  -h, --help     Print help
11
  -V, --version  Print version
12
13
Format Configuration:
14
  -l, --line-width <LINE_WIDTH>      Maximum width of each line [default: 80] [aliases: -c, --column]
15
  -t, --indent-width <INDENT_WIDTH>  Number of spaces per indentation level [default: 2] [aliases: --tab-width]
16
      --no-reorder-import-items      Disable alphabetical reordering of import items
17
      --wrap-text                    Wrap text in markup to fit within the line width, and collapse spaces in markup
18
19
Debug Options:
20
  -a, --ast         Print the AST of the input file
21
  -p, --pretty-doc  Print the pretty document
22
      --timing      Show elapsed time taken by the formatter
23
24
Log Levels:
25
  -v, --verbose  Enable verbose logging
26
  -q, --quiet    Print diagnostics, but nothing else
27

1
# Format multiple files
2
typstyle -i chapter1.typ chapter2.typ appendix.typ
3
4
# Format entire project
5
typstyle -i .
6
7
# Format with specific configuration
8
typstyle -l 100 -t 4 --wrap-text -i src/

1
# Format from stdin (default)
2
cat file.typ | typstyle
3
4
# Format specific files
5
typstyle file1.typ file2.typ
6
7
# Format directories (recursively)
8
typstyle src/ docs/

1
# Modify files directly
2
typstyle -i file.typ
3
typstyle --inplace file.typ

1
# Exit with non-zero if formatting needed
2
typstyle --check src/

1
# Like --check, but shows unified diff of what formatting changes would be made
2
typstyle --diff src/

1
# Set maximum line width (default: 80)
2
typstyle -l 100 file.typ
3
typstyle --line-width 100 file.typ

1
# Set indentation width (default: 2)
2
typstyle -t 4 file.typ
3
typstyle --indent-width 4 file.typ

1
# Wrap text in markup to fit line width
2
typstyle --wrap-text file.typ

1
# Print the Abstract Syntax Tree
2
typstyle -a file.typ
3
typstyle --ast file.typ

1
# Print the internal pretty document representation
2
typstyle -p file.typ
3
typstyle --pretty-doc file.typ

1
# Show elapsed time taken by the formatter
2
typstyle --timing file.typ