Skip to content

docs: fix non-working cargo install instructions #2

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
raffaelschneider merged 1 commit into from
Aug 21, 2026
Merged

docs: fix non-working cargo install instructions #2

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
23 changes: 21 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,31 @@ zentinel bundle install js
zentinel bundle install
```

The bundle command downloads the correct binary for your platform and places it in the standard location. See the [bundle documentation](https://zentinelproxy.io/docs/deployment/bundle/) for details.
The bundle command downloads the correct binary for your platform and places it in the standard location. See the [bundle documentation](https://docs.zentinelproxy.io/deployment/bundle/) for details.

### Using Cargo

`zentinel-agent-js` is not published on crates.io, so `cargo install zentinel-agent-js` does not
work. Install straight from the repository instead:

```bash
cargo install --git https://github.com/zentinelproxy/zentinel-agent-js
```

This builds and installs the `zentinel-js-agent` binary.

### Prebuilt Binaries

Each [release](https://github.com/zentinelproxy/zentinel-agent-js/releases) ships binaries
for `linux-x86_64`, `linux-aarch64`, and `darwin-aarch64`:

```bash
cargo install zentinel-agent-js
VERSION=0.3.0
PLATFORM=linux-x86_64 # or linux-aarch64, darwin-aarch64
curl -fsSL -o zentinel-js-agent.tar.gz \
"https://github.com/zentinelproxy/zentinel-agent-js/releases/download/v${VERSION}/zentinel-js-agent-${VERSION}-${PLATFORM}.tar.gz"
tar -xzf zentinel-js-agent.tar.gz
sudo install -m 0755 zentinel-js-agent /usr/local/bin/
```

### From Source
Expand Down