Repository navigation
Conversation
The file flag's shorthand is -F. The -f example fails with an unknown shorthand flag error and is copied into the generated docs.
The generator listed every flag, including hidden ones such as the deprecated --admin-api-key, and showed --profile without its deprecation notice. Skip hidden flags so the docs and describe match --help, and render the deprecation message for visible deprecated flags. The describe output gains a deprecated field.
The help text named SSH sessions and containers as the use case, but the callback server listens on localhost, so the URL must be opened on the same machine. Say that, and point browserless machines to environment variables.
The algolia formula lives in homebrew/core, so the tap path is no longer needed.
kai687
marked this pull request as ready for review
November 20, 2026 09:50
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
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.
Changes
Found while reviewing the CLI docs against the code.
internal/docslisted every flag, including hidden ones such as the deprecated--admin-api-key, and showed--profilewithout its deprecation notice. Hidden flags are now skipped so the generated docs andalgolia describematch--help. Visible deprecated flags render a**Deprecated:** …line, and thedescribeJSON gains adeprecatedfield. New test covers both cases.algolia rules import MOVIES -f rules.jsonused the wrong shorthand. The flag is-F.--no-browsertext named SSH sessions and containers as the use case, but the callback server listens on localhost, so the URL has to be opened on the same machine. Reworded, and browserless machines are pointed to environment variables.brew install algolia, the formula is in homebrew/core.Regenerating the docs against this branch changes only
commands/index.mdx: the example line,--admin-api-keyremoved,--profilegains the deprecation line. All other pages are identical.Checks
go build ./...go test ./internal/docs/... ./pkg/cmd/root/... ./pkg/cmd/auth/login/... ./pkg/cmd/describe/...golangci-lint runon the changed packages