Skip to content

Conversation

@iitslamaa
Copy link
Contributor

Adds missing documentation for the --no-open flag under promptfoo view.

  • Updates: site/docs/usage/command-line.md
  • Section: ## promptfoo view
  • Adds: --no-open row in the options table + an example using --port 15550 --no-open

Rationale: --no-open is supported in the CLI but wasn’t listed on the Command-line docs page. This improves discoverability for CI/headless workflows and for users who prefer to copy the URL instead of auto-opening a browser.

Docs-only change.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 30, 2025

📝 Walkthrough

Walkthrough

This pull request updates the command-line documentation to include information about a new --no-open CLI option for the view command. The option allows users to start the local server without automatically opening a browser window. The change consists of documentation additions and example usage in the command-line reference guide with no modifications to functional code.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Documentation-only change with no code logic modifications
  • Single file updated with new option description and usage example
  • No functional impact, control-flow changes, or error handling modifications

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
Title check ❓ Inconclusive The title 'docs: document promptfoo view --no flag in command-line docs' is partially related to the changeset but uses imprecise terminology ('--no flag' instead of '--no-open flag'), which may cause confusion when scanning PR history. Consider revising the title to 'docs: document promptfoo view --no-open flag in command-line docs' for clarity and accuracy.
✅ Passed checks (1 passed)
Check name Status Explanation
Description Check ✅ Passed The pull request description is clearly related to the changeset and provides meaningful information about the change. It specifies the file being modified (site/docs/usage/command-line.md), the section affected (## promptfoo view), and what is being added (--no-open row in options table and usage example). The description includes rationale for why the change improves the documentation and explicitly notes this is a docs-only change, all of which aligns with the actual changeset content.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@iitslamaa
Copy link
Contributor Author

@mldangelo hi! Docs-only PR adding the missing --no-open flag to promptfoo view + example.
Ready for review, happy to adjust wording or placement.

@mldangelo mldangelo changed the title docs(cli): document 'promptfoo view --no-open' with example docs(cli): document 'promptfoo view --no' flag with example Nov 4, 2025
mldangelo added a commit that referenced this pull request Nov 4, 2025
The PR was documenting a --no-open flag that doesn't exist. The actual
flag in src/commands/view.ts is -n, --no.

Changes:
- Fix table entry from --no-open to -n, --no
- Update example command to use --no instead of --no-open
- Fix changelog section from "Docs" to "Documentation"
- Add conventional commit prefix "docs:" and PR reference (#6067)
Add documentation for the -n, --no flag which allows starting the
viewer without opening a browser. The flag is defined in
src/commands/view.ts:16 but was missing from the CLI documentation.
@mldangelo mldangelo changed the title docs(cli): document 'promptfoo view --no' flag with example docs: document promptfoo view --no flag in command-line docs Nov 4, 2025
@mldangelo mldangelo force-pushed the docs/view-no-open-flag branch from 1d4da1b to 85a21dd Compare November 4, 2025 04:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants