Skip to content

docs: Document --version CLI argument#15

Closed
promptless[bot] wants to merge 1 commit intomainfrom
promptless/add-version-cli-docs
Closed

docs: Document --version CLI argument#15
promptless[bot] wants to merge 1 commit intomainfrom
promptless/add-version-cli-docs

Conversation

@promptless
Copy link
Contributor

@promptless promptless bot commented Mar 1, 2026

Open this suggestion in Promptless to view citations and reasoning process

Adds documentation for the new --version CLI argument that displays the installed Doc Detective version. The new section is added to the "Explore sample tests" page alongside other CLI arguments like --input and --config.

Trigger Events

doc-detective/doc-detective PR #176: Add version information to command-line arguments

Promptless Research (1 GitHub PR)

Agent Response

I've completed the documentation update for PR #176. Here's a summary:

Summary

PR #176 adds version information to the Doc Detective command-line interface by implementing the --version flag. Users can now check which version of Doc Detective they have installed.

Documentation Update

I created a new suggestion that adds a "Check version" section to the Explore sample tests page (fern/pages/docs/get-started/sample-tests.mdx). This page already documents other CLI arguments like --input and --config, making it the natural place to add --version.

The new section includes examples for both NPX and Docker usage:

# NPX
npx doc-detective --version

# Docker
docker run docdetective/docdetective --version

Suggestion URL: https://app.gopromptless.ai/suggestions/6930dd84-51e1-4b72-bb09-a39ac78e3ff9


Tip: See how your feedback shapes Promptless in Agent Knowledge Base 🧠


These tests run the same way as local tests, but Doc Detective fetches the test file from the specified URL and stores it in a temporary directory. The URL must be accessible to the machine running the tests.

### Check version
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Based on PR #176 which adds .version(require("../package.json").version) to the CLI arguments in src/utils.ts, enabling the --version flag.
View source

@github-actions
Copy link

github-actions bot commented Mar 1, 2026

@hawkeyexl
Copy link
Contributor

Unnecessary to document.

@hawkeyexl hawkeyexl closed this Mar 1, 2026
@promptless promptless bot marked this pull request as ready for review March 1, 2026 03:17
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.

1 participant