Skip to content

Fixed installation instructions for devguard-cli #143

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

Merged
timbastin merged 3 commits into from
Jun 23, 2026
+26 −3
Merged

Fixed installation instructions for devguard-cli #143

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9752d11
Fixed installation instructions for devguard-cli
Dboy0ZDev Jun 22, 2026
2e7a0a4
reverted package-lock.json changes, adds compatibility notes to insta…
timbastin Jun 23, 2026
061f7c0
adds versioning policy
timbastin Jun 23, 2026
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
29 changes: 26 additions & 3 deletions src/pages/getting-started/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,17 +179,20 @@ The CLI tool provides additional management capabilities for vulnerability datab
go install github.com/l3montree-dev/devguard/cmd/devguard-cli@latest

# Verify
devguard-cli --version
devguard-cli --help
```
</Tabs.Tab>

<Tabs.Tab>
```bash
# Pull image
docker pull ghcr.io/l3montree-dev/devguard-cli:latest
docker pull ghcr.io/l3montree-dev/devguard:main

# Create alias
alias devguard-cli='docker run --rm -v $(pwd):/work ghcr.io/l3montree-dev/devguard-cli:latest'
alias devguard-cli='docker run --rm -v $(pwd):/work ghcr.io/l3montree-dev/devguard:main devguard-cli'

#Verify
devguard-cli --help
```
</Tabs.Tab>

Expand Down Expand Up @@ -222,6 +225,26 @@ See the [Docker Compose Deployment Guide](/how-to-guides/administration/deploy-w
</Tabs>


***

## Versioning and Compatibility

All DevGuard components share the same **minor version**. Any `vX.Y.*` release of one component is compatible with any `vX.Y.*` release of any other component. Patch versions are released independently — you can upgrade one component without upgrading others, as long as the minor version matches.

| Component | Compatible example |
|-----------|--------------------|
| DevGuard (API/backend) | `v1.7.5` |
| DevGuard Web (frontend) | `v1.7.2` |
| Helm chart | `v1.7.0` |

All three above are compatible — they share minor version `1.7`.

<Callout type="warning">
Mixing components with different minor versions (e.g. `devguard v1.7.x` with `devguard-web v1.8.x`) is **not supported**.
</Callout>

See the full [Versioning Policy](https://github.com/l3montree-dev/devguard/blob/main/VERSIONING.md) for details. For a full history of changes see the [DevGuard CHANGELOG](https://github.com/l3montree-dev/devguard/blob/main/CHANGELOG.md) and the [Helm Chart CHANGELOG](https://github.com/l3montree-dev/devguard-helm-chart/blob/main/CHANGELOG.md).

***

## Next Steps
Expand Down
Loading