Skip to content

Commit 267a301

Browse files
authored
docs: ✏️ Update README with installation instructions for CLI and features (#79)
Signed-off-by: Onuralp SEZER <onuralp@ultralytics.com>
1 parent 6bd807f commit 267a301

1 file changed

Lines changed: 25 additions & 1 deletion

File tree

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,32 @@ High-performance YOLO inference library written in Rust. This library provides a
4141
git clone https://github.com/ultralytics/inference.git
4242
cd inference
4343

44-
# Build release version
44+
# Build release binary (not installed globally)
4545
cargo build --release
46+
47+
# Install CLI globally from this git checkout (Cargo default location)
48+
cargo install --path . --locked
49+
50+
# Install CLI globally with custom features
51+
# Minimal build (no default features)
52+
cargo install --path . --locked --no-default-features
53+
54+
# Enable video support
55+
cargo install --path . --locked --features video
56+
57+
# Enable multiple accelerators
58+
cargo install --path . --locked --features "cuda,tensorrt"
59+
```
60+
61+
`cargo install` places binaries in Cargo's default bin directory:
62+
63+
- macOS/Linux: `~/.cargo/bin`
64+
- Windows: `%USERPROFILE%\\.cargo\\bin`
65+
66+
Ensure this directory is in your `PATH`, then run from anywhere:
67+
68+
```bash
69+
ultralytics-inference --help
4670
```
4771

4872
### Export a YOLO Model to ONNX

0 commit comments

Comments
 (0)