Dark-Alex-17/managarr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Updated README with config-path as another way to find the default config file for a given system

Browse Source
This commit is contained in:
Alex Clarke
2026-01-29 10:26:12 -07:00
parent c6d5b98e86
commit 892c687077
1 changed files with 21 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+21 -7
View File
@@ -259,6 +259,8 @@ Commands:
lidarr Commands for manging your Lidarr instance lidarr Commands for manging your Lidarr instance
completions Generate shell completions for the Managarr CLI completions Generate shell completions for the Managarr CLI
tail-logs Tail Managarr logs tail-logs Tail Managarr logs
config-path Print the full path to the default configuration file.
This file can be changed to another location using the '--config-file' flag
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
Options: Options:
@@ -266,14 +268,23 @@ Options:
-V, --version Print version -V, --version Print version
Global Options: Global Options:
--disable-spinner Disable the spinner (can sometimes make parsing output challenging) [env: MANAGARR_DISABLE_SPINNER=] --disable-spinner Disable the spinner (can sometimes make parsing output
--config-file <CONFIG_FILE> The Managarr configuration file to use [env: MANAGARR_CONFIG_FILE=] challenging) [env: MANAGARR_DISABLE_SPINNER=]
--themes-file <THEMES_FILE> The Managarr themes file to use [env: MANAGARR_THEMES_FILE=] --config-file <CONFIG_FILE> The Managarr configuration file to use; defaults to the
--theme <THEME> The name of the Managarr theme to use [env: MANAGARR_THEME=] path shown by 'managarr config-path' [env:
--servarr-name <SERVARR_NAME> For multi-instance configurations, you need to specify the name of the instance configuration that you want to use. MANAGARR_CONFIG_FILE=]
--themes-file <THEMES_FILE> The Managarr themes file to use [env:
MANAGARR_THEMES_FILE=]
--theme <THEME> The name of the Managarr theme to use [env:
MANAGARR_THEME=]
--servarr-name <SERVARR_NAME> For multi-instance configurations, you need to specify
the name of the instance configuration that you want to
use.
This is useful when you have multiple instances of the same Servarr defined in your config file. This is useful when you have multiple instances of the
By default, if left empty, the first configured Servarr instance listed in the config file will be used. same Servarr defined in your config file.
By default, if left empty, the first configured Servarr
instance listed in the config file will be used.
``` ```
All subcommands also have detailed help menus to show you how to use them. For example, to see all available commands for Sonarr, you would run: All subcommands also have detailed help menus to show you how to use them. For example, to see all available commands for Sonarr, you would run:
@@ -332,6 +343,9 @@ but all servers will require you to input the API token.
The configuration file is located somewhere different for each OS. The configuration file is located somewhere different for each OS.
You can use `managarr config-path` to locate the default configuration file for your system. In general, the default
config file paths for each system is listed below:
### Linux ### Linux
``` ```
$HOME/.config/managarr/config.yml $HOME/.config/managarr/config.yml