docs(cli): document the three environment-only settings - #4
Merged
Conversation
MANTIS_ASCII, MANTIS_QUIET and MANTIS_BULK_CREATE_MAX_BYTES are read by the CLI but appeared nowhere in the docs. They have no flag equivalent, so there was no way to discover them short of reading the source. MANTIS_QUIET is worth calling out explicitly: it silences the keychain advisory on stderr and is NOT the environment form of -q/--quiet, which suppresses stdout. Easy to conflate. Also note the 64 MiB bulk-create input cap under the command itself — hitting it produces an error naming the override, but nothing documented the limit before you hit it. Verified against cli/src/lib/out.ts, cli/src/lib/keychain-notice.ts and cli/src/commands/bulk-create.ts at mantis@origin/main.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of a sweep across the privacykey docs repos, checking documented claims against the product source.
docs-mantis came out well: all 28 nav pages resolve, the CLI reference covers every command in
cli/src/commands/, and every feature in the mantis README (file keys,.pkpass, host events, NFC/QR, Home Assistant, Scrypted, Uptime Kuma, all five notification channels) has prose somewhere. The version pins in the README — CLIv0.1.6, serverv0.1.1, edgev0.1.3— match the tags.The one real gap: comparing every
process.env.*read insrc/,cli/src/andmantis-edge/against the docs left three product variables documented nowhere.MANTIS_ASCIIcli/src/lib/out.tsMANTIS_QUIETcli/src/lib/keychain-notice.tsMANTIS_BULK_CREATE_MAX_BYTEScli/src/commands/bulk-create.tsNone has a flag equivalent, so they were undiscoverable without reading the source. Added as an "Environment-only settings" subsection under Global flags.
MANTIS_QUIETgets an explicit disambiguation — it silences the keychain advisory on stderr, and is not the environment form of-q/--quiet, which suppresses stdout. The names invite conflation.The 64 MiB
bulk-createcap also now appears under the command. The error message names the override when you hit it, but nothing warned you beforehand.Everything else checked clean:
MANTIS_BACKUP_PASSincli-backup.mdis an example name passed to--passphrase-env, not a hardcoded variable. Correct as written.deployment/README.mdduplicatingdeployment/index.mdxis deliberate —.mintignorekeeps the GitHub-facing copy off the site. Left alone. (Minor: the README version's comparison table has five rows the site version dropped — DDoS protection, edge regions, privacy posture, free tier, best-for. Worth a look if that trim wasn't intentional.)