Skip to content

Document --no-color and the live progress board for preview and upgrade #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adamXbot merged 1 commit into from
Oct 12, 2026
Merged

Document --no-color and the live progress board for preview and upgrade #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,12 @@ it:
privacycommand preview --fetch firefox
```

On a terminal, `preview` draws a live progress board on stderr while it
works: one row per app with the analysis step it's on — with `--fetch`, how
many MB of the download have arrived — and then its result as it finishes.
The board clears before the report prints. It only appears when stderr is a
terminal, so piped output and `--json` are unchanged.

After the apps, it lists what it couldn't analyse: casks that install no app
(command-line tools, fonts and the like) with the reason, and your outdated
formulae, so you can see everything `brew upgrade` would touch. Without
Expand All @@ -194,6 +200,7 @@ formulae, so you can see everything `brew upgrade` would touch. Without
| `--max-risk <limit>` | Mark each cask cleared or held for review against a risk limit, and exit 3 if anything is held — see [below](#upgrading-within-a-risk-limit) |
| `--only-noteworthy` | Suppress apps with nothing to say |
| `--min-tier <tier>` | Only report at or above a risk tier — `low`, `medium`, `high` or `critical`. Anything else exits 2 |
| `--no-color` | Plain output. Setting `NO_COLOR` in the environment does the same |
| `--json` | Machine-readable output |

<Note>
Expand Down Expand Up @@ -250,6 +257,9 @@ compares its risk with the limit — a tier (`low`, `medium`, `high`,
leaves them held without asking, and is implied when stdin isn't a terminal
and with `--json`.

On a terminal it shows the same live progress board as `preview --fetch`: each
cask's download in MB, then its analysis, then its result.

Casks that install no app, and outdated formulae, are neither analysed nor
upgraded. The footer lists them with the `brew` command to run yourself.

Expand All @@ -260,6 +270,7 @@ upgraded. The footer lists them with the `brew` command to run yourself.
| `--no-input` | With `--max-risk`: don't ask about held casks |
| `--greedy` | Include casks that normally update themselves |
| `--min-tier <tier>`, `--only-noteworthy` | As for `preview`. Not with `--max-risk`, which judges every cask |
| `--no-color` | Plain output. Setting `NO_COLOR` in the environment does the same |
| `--json` | Machine-readable output; `brew`'s own output goes to stderr |

| Exit code | Meaning |
Expand Down
11 changes: 11 additions & 0 deletions llms-full.txt
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading