Skip to content

docs: Document --version CLI argument #15

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

Closed
promptless wants to merge 1 commit into from
Closed

docs: Document --version CLI argument #15

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
21 changes: 21 additions & 0 deletions fern/pages/docs/get-started/sample-tests.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,27 @@ The `-v` argument is not necessary for remotely hosted tests since Docker doesn'

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

@promptless promptless bot Mar 1, 2026

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


To check your installed version, use the `--version` argument:

<Tabs>
<Tab title="NPX" language="npx">

```bash
npx doc-detective --version
```

</Tab>
<Tab title="Docker" language="docker">

```bash
docker run docdetective/docdetective --version
```

</Tab>
</Tabs>

## Next steps

- [Resources](./resources)