|
32 | 32 | - [Prerequisites](#prerequisites) |
33 | 33 | - [Installing](#installing) |
34 | 34 | - [Binary release](#binary-release) |
35 | | - - [Homebrew tap (macOS and linux) (amd64 and arm64)](#homebrew-tap-macos-and-linux-amd64-and-arm64) |
| 35 | + - [Homebrew (macOS and linux) (amd64 and arm64)](#homebrew-macos-and-linux-amd64-and-arm64) |
36 | 36 | - [AUR](#aur) |
37 | 37 | - [From source](#from-source) |
38 | 38 | - [Getting started](#getting-started) |
| 39 | + - [Command line interface](#command-line-interface) |
39 | 40 | - [Customizing](#customizing) |
40 | 41 | - [Symbols](#symbols) |
41 | 42 | - [Styles](#styles) |
@@ -90,6 +91,29 @@ you run or when you switch windows, however it won't refresh automatically, nor |
90 | 91 |
|
91 | 92 | Note that `tmux v2.1` was released in 2015 so you're probably better off updating to a more recent version anyway 🙂. |
92 | 93 |
|
| 94 | + |
| 95 | +### Command line interface |
| 96 | + |
| 97 | +`gitmux` is not meant to be used directly but it still has a command line interface |
| 98 | +that can be used to troubleshoot your installation, or create the default configuration: |
| 99 | + |
| 100 | +``` |
| 101 | +$ gitmux -h |
| 102 | +gitmux v0.11.5 |
| 103 | +Usage: gitmux [options] [dir] |
| 104 | +
|
| 105 | +gitmux prints the status of a Git working tree as a tmux format string. |
| 106 | +If directory is not given, it default to the working directory. |
| 107 | +
|
| 108 | +Options: |
| 109 | + -cfg FILE read gitmux config from FILE. |
| 110 | + -printcfg prints default configuration file. |
| 111 | + -dbg outputs Git status as JSON and print errors. |
| 112 | + -timeout DUR exits if still running after given duration (ex: 2s, 500ms). |
| 113 | + -V prints gitmux version and exits. |
| 114 | +``` |
| 115 | + |
| 116 | + |
93 | 117 | ## Customizing |
94 | 118 |
|
95 | 119 | `gitmux` output can be customized via a configuration file in YAML format. |
|
0 commit comments