Skip to content

docs(cli): document the three environment-only settings #4

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
AdamXweb merged 1 commit into from
Aug 9, 2026
+14 −0
Merged

docs(cli): document the three environment-only settings #4

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
14 changes: 14 additions & 0 deletions cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@ program, so they work the same everywhere.
| `-v, --version` | Print the CLI version |
| `-h, --help` | Show help for any command |

### Environment-only settings

Three settings have no flag — they only exist as environment variables.

| Variable | Default | Purpose |
|---|---|---|
| `MANTIS_ASCII` | (unset) | Set to any value to force plain-ASCII output. The CLI defaults to Unicode glyphs (`…` `·` `←` `🔐`) and already falls back to ASCII on `TERM=dumb` or a non-UTF-8 locale; this is the explicit opt-out for terminals that render them as mojibake anyway. |
| `MANTIS_QUIET` | (unset) | Set to `1` to suppress the one-time keychain notice on stderr. Distinct from `-q, --quiet`, which suppresses human-readable **stdout** — this only silences that advisory. |
| `MANTIS_BULK_CREATE_MAX_BYTES` | `67108864` (64 MiB) | Input-size cap for `mantis bulk-create`, guarding against a pathological CSV (a 10 GB file, or an unclosed quoted field) exhausting memory. Values below 1024, or anything non-integer, are ignored and the default applies. |

### How a command picks its server

Resolution happens when the command runs, in this order:
Expand Down Expand Up @@ -215,6 +225,10 @@ Bulk-create keys from a CSV and write an output CSV with the generated URLs.
| `--fail-fast` | Stop after the first row-level failure |
| `--dry-run` | Validate rows and write the output CSV without creating keys |

The input CSV is capped at **64 MiB**. Raise it with
[`MANTIS_BULK_CREATE_MAX_BYTES`](#environment-only-settings) if you trust the
file.

### `mantis list` (alias `ls`)

List keys.
Expand Down
Loading