CLI Usage

1
Usage: typstyle [OPTIONS] [INPUT]...
2
3
Arguments:
4
  [INPUT]...
5
          List of files or directories to format [default: stdin]
6
7
Options:
8
  -i, --inplace
9
          Format the file in place
10
11
      --check
12
          Run in 'check' mode. Exits with 0 if input is formatted correctly. Exits with a non-zero status code if formatting is required
13
14
      --diff
15
          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
16
17
  -h, --help
18
          Print help (see a summary with '-h')
19
20
  -V, --version
21
          Print version
22
23
Format Configuration:
24
  -l, --line-width <LINE_WIDTH>
25
          Maximum width of each line
26
          
27
          [default: 80]
28
          [aliases: -c, --column]
29
30
  -t, --indent-width <INDENT_WIDTH>
31
          Number of spaces per indentation level
32
          
33
          [default: 2]
34
          [alias: --tab-width]
35
36
      --line-ending <LINE_ENDING>
37
          Line-ending policy for formatted source output
38
39
          Possible values:
40
          - lf:       Generate LF breaks, preserving literal source text
41
          - crlf:     Generate CRLF breaks, preserving literal source text
42
          - preserve: Generate CRLF only when the input contains CRLF and no bare LF or CR
43
          
44
          [default: preserve]
45
46
      --no-reorder-import-items
47
          Disable alphabetical reordering of import items
48
49
      --wrap-text[=<WRAP_TEXT>]
50
          Text wrapping mode: none (default), fill (wrap to line width), sentence (one per line), or fill-sentence (both)
51
52
          Possible values:
53
          - none:          Do not wrap text (default)
54
          - fill:          Wrap text to fit within line width
55
          - sentence:      Place each sentence on its own line
56
          - fill-sentence: Place each sentence on its own line, wrapping long sentences to the line width
57
          
58
          [default: none]
59
60
Debug Options:
61
  -a, --ast
62
          Print the AST of the input file
63
64
  -p, --pretty-doc
65
          Print the pretty document
66
67
      --timing
68
          Show elapsed time taken by the formatter
69
70
Log Levels:
71
  -v, --verbose
72
          Enable verbose logging
73
74
  -q, --quiet
75
          Print diagnostics, but nothing else
76

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
# Force LF, including when checking in CI
2
typstyle --line-ending=lf file.typ
3
4
# Force CRLF
5
typstyle --line-ending=crlf --inplace file.typ
6
7
# Preserve the existing convention (the default)
8
typstyle --line-ending=preserve --inplace file.typ

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 (`--wrap-text` is shorthand)
2
typstyle --wrap-text file.typ
3
typstyle --wrap-text=fill file.typ
4
5
# Place each sentence on its own line
6
typstyle --wrap-text=sentence file.typ
7
8
# Place each sentence on its own line, and wrap long sentences to the line width
9
typstyle --wrap-text=fill-sentence 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