Skip to content

Commit

Permalink
Add docs for CLI Config
Browse files Browse the repository at this point in the history
  • Loading branch information
juraj-hrivnak committed Jul 22, 2024
1 parent dc4b6ee commit 9f70ae2
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/p.tree
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
<toc-element toc-title="Configuring Pakku">
<toc-element topic="Config-File.md"/>
<toc-element topic="Pakku-Directory.md"/>
<toc-element topic="CLI-Config.md"/>
</toc-element>
<toc-element toc-title="Reference">
<toc-element toc-title="CLI Commands">
Expand Down
19 changes: 19 additions & 0 deletions docs/topics/CLI-Config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# CLI Config

CLI Config (`cli-config.json`) is an optional file
which can be used to modify the UI aspects of the Pakku CLI.

The `cli-config.json` must be located in the [Pakku directory (`.pakku`)](Pakku-Directory.md).
The relative path from the `.minecraft` directory should be: `.pakku/cli-config.json`.

## Properties

`theme`
: Can be `default` or `ascii`. (Defaults to `default` 😜.)
: - The `default` theme uses [UTF-8](https://en.wikipedia.org/wiki/UTF-8) symbols
which may not be properly rendered in some terminals.
: - The `ascii` theme limits the characters to [ASCII](https://en.wikipedia.org/wiki/ASCII) only.

`ansi_level`
: Can be `none`, `ansi16`, `ansi256` or `truecolor`.
(By default it is automatically detected based on your terminal/CMD.)

0 comments on commit 9f70ae2

Please sign in to comment.