Skip to content

Commit

Permalink
Add new flag info to README
Browse files Browse the repository at this point in the history
  • Loading branch information
JamyGolden committed Sep 24, 2024
1 parent 171617c commit fc8f462
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -173,14 +173,16 @@ The following is a table of the available subcommands for the CLI tool (Tinty),

Some subcommands support additional flags and options to modify their behavior:

| Flag/Option | Description | Applicable Subcommands | Default Value | Example Usage |
|-------------------|-----------------------------------------|------------------------|---------------|-------------------------------------------|
| `--config` `-c` | Specifies a custom configuration file path. | All | If not provided tinty looks for `config.toml` at `$XDG_CONFIG_HOME/tinted-theming/tinty/config.toml` otherwise `~/.config/tinted-theming/tinty/config.toml` | `tinty apply base16-ayu-dark --config /path/to/custom/config.toml` |
| `--data-dir` | Specifies a custom path for the data directory. | All | If not provided tinty looks for the data directory at `$XDG_DATA_HOME/tinted-theming/tinty` otherwise `~/.local/share/tinted-theming/tinty` | `tinty install --data-dir /path/to/custom/data-dir` |
| `--help` `-h` | Displays help information for the subcommand. | All | - | `tinty --help`, `tinty apply --help`, etc. |
| `--version` `-V` | Shows the version of tinty. | All | - | `tinty --version` |
| `--config-path` | Shows the config.yml path. | `config` | - | `tinty config --config-path` |
| `--data-dir-path` | Shows the data directory path. | `config` | - | `tinty config --data-dir-path` |
| Flag/Option | Description | Applicable Subcommands | Default Value | Example Usage |
|--------------------|-----------------------------------------|------------------------|---------------|-------------------------------------------|
| `--config` `-c` | Specifies a custom configuration file path. | All | If not provided tinty looks for `config.toml` at `$XDG_CONFIG_HOME/tinted-theming/tinty/config.toml` otherwise `~/.config/tinted-theming/tinty/config.toml` | `tinty apply base16-ayu-dark --config /path/to/custom/config.toml` |
| `--data-dir` | Specifies a custom path for the data directory. | All | If not provided tinty looks for the data directory at `$XDG_DATA_HOME/tinted-theming/tinty` otherwise `~/.local/share/tinted-theming/tinty` | `tinty install --data-dir /path/to/custom/data-dir` |
| `--help` `-h` | Displays help information for the subcommand. | All | - | `tinty --help`, `tinty apply --help`, etc. |
| `--version` `-V` | Shows the version of tinty. | All | - | `tinty --version` |
| `--config-path` | Shows the config.yml path. | `config` | - | `tinty config --config-path` |
| `--data-dir-path` | Shows the data directory path. | `config` | - | `tinty config --data-dir-path` |
| `--custom-schemes` | Lists saved custom theme files manually created or generated by `tinty generate-scheme` | `list` | - | `tinty list --custom-schemes` |
| `--quiet` | Silences stdout and stderr printing | `build` | - | `tinty build . --quiet` |

## Configuration

0 comments on commit fc8f462

Please sign in to comment.