rux add
Purpose
Add a brand new external dependency link directly into the package configuration file.
Synopsis
rux add [namespace]/[package]
rux add [namespace]/[package]@[requirement]
rux add [package] --path [path]
Behavior
Registry dependencies require a namespaced identity such as Rux/Io; an optional @requirement constrains the resolved version. --path adds a local dependency instead. The command updates Rux.toml only after registry validation succeeds.
Arguments
| Argument | Required | Description |
|---|---|---|
package | Yes | A namespaced package identity and optional requirement |
Options
| Option | Description |
|---|---|
--path <path> | Add a local path-based dependency |
--registry <url> | Registry API base URL to check the package against |
Global options may appear before or after the command. See Global options.
Output and exit status
Primary results are written to stdout. Progress, warnings, and errors are written to stderr.
Success exits 0, invalid command-line usage exits 2, and compiler, validation, filesystem, network, or generation failures exit 1 unless stated otherwise above.
Examples
rux add Rux/Io
rux add Rux/Io@^0.1.0
rux add Json --path ../Json
Environment variables
RUX_REGISTRY_URL sets the default registry when --registry is absent.
The global color environment behavior is described under Global options.