Skip to content

Commit

Permalink
Document new NO_COLOR env var for CLI commands
Browse files Browse the repository at this point in the history
  • Loading branch information
rcdailey committed Jun 19, 2024
1 parent e0f4149 commit 72fad3a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
14 changes: 14 additions & 0 deletions docs/cli/common.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Common Options
sidebar_position: 1
---

## Options

These are options shared by *all* commands.

### `-h|--help`
Expand All @@ -25,3 +27,15 @@ in the official Docker image. It is not intended for normal use outside of that.
If you'd like this behavior globally for all commands without having to specify this option, define
an environment variable named `RECYCLARR_APP_DATA` with the same path. Note that if you have both
set, `--app-data` always takes precedence.

## Environment Variables

These environment variables impact the behavior of *all* commands.

### `NO_COLOR`

When set like `NO_COLOR=1`, disable ANSI color output for all Recyclarr commands. This is useful for
scenarios such as scripting and piping output to files. Note that this also disables color output to
the terminal as well.

See [no-color.org](https://no-color.org/) for more information about this standard convention.
3 changes: 2 additions & 1 deletion docs/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ or angle-brackets (e.g. `<required>`).

## Commands

Also visit the [Common Options](common.md) page to learn about options usable across *all* commands.
Also visit the [Common Options](common.md) page to learn about options and environment variables
usable across *all* commands.

- [recyclarr](main.md)
- [recyclarr sync](sync.md)
Expand Down

0 comments on commit 72fad3a

Please sign in to comment.