Getting started

Common Commands

These commands cover the normal operator workflow from discovery through dry-run planning and controlled execution.

Choose Your Command Prefix

The examples below use the installed command:

Bash

raylimit ...

If you are running from source instead of an installed release package, replace that prefix with one of these:

Bash

go run ./cmd/raylimit ...
./bin/raylimit ...

The command behavior is the same. The difference is only how you launch the binary.

Start by listing the runtimes RayLimit can currently see:

Bash

sudo raylimit discover

Use JSON when you want a machine-readable list:

Bash

sudo raylimit discover --format json

Inspect one selected runtime before you plan any speed limiter:

Bash

sudo raylimit inspect --pid 1234
sudo raylimit inspect --pid 1234 --format json

This gives you the current runtime identity, host-visible metadata, and API-capability hints when they are available.

If you are running from source, these are the direct equivalents:

Bash

go run ./cmd/raylimit --help
make build
./bin/raylimit --help

Dry-run is the default. Start there:

Bash

sudo raylimit limit --pid 1234 --ip 203.0.113.10 --device eth0 --direction upload --rate 2048

For the preferred identity-oriented shared-pool path:

Bash

sudo raylimit limit --pid 1234 --uuid user-a --device eth0 --direction upload --rate 2048

Add --execute only when the dry-run output shows a concrete execution path:

Bash

sudo raylimit limit --pid 1234 --outbound proxy-out --device eth0 --direction upload --rate 2048 --execute

Remove uses the same selection model and stays conservative:

Bash

sudo raylimit limit --pid 1234 --ip 203.0.113.10 --device eth0 --direction upload --remove --execute

The same commands can be rendered in JSON:

Bash

sudo raylimit limit --pid 1234 --uuid user-a --device eth0 --direction upload --rate 2048 --format json

Bash

raylimit version

Use the sidebar to continue into practical usage, speed limiter families, and troubleshooting.