rustydocs

CLI reference

Complete rusty command reference for 0.0.1-dev.

Invoke rusty with no arguments or rusty --help to print usage. Version: rusty --version.

Global flags

FlagDescription
-h, --helpShow help
-V, --versionPrint version (0.0.1-dev)

Language / toolchains

CommandDescription
rusty env install <id> [target...]Install a toolchain
rusty env uninstall <id>Remove a toolchain
rusty env listList installed toolchains
rusty env showActive toolchain, host triple, rusty home
rusty env which <prog>Path to <prog> in active toolchain
rusty env use <id>Set default toolchain

Package manager

CommandDescription
rusty init [name] [--format cargo|rusty] [--kind KIND] [--edition YYYY]Scaffold a project
rusty migrate [--yes] [--dry-run]Convert Cargo → rusty manifests
rusty lockGenerate or update lockfile
rusty fetchResolve (if needed) + ingest deps into CAS
rusty build, run, checkNative driver when supported; else cargo
rusty test [FILTER]...Native test runner (never cargo); see Test
rusty test -p PKG --workspaceMulti-package testing
rusty test --affected [base]Test packages changed since base (+ reverse deps)
rusty test --affected-direct [base]Test path-touched packages only
rusty test -j NShared compile+run job budget (RUSTY_JOBS / CARGO_BUILD_JOBS)
rusty test --shard k/nRun 1-based unit-plan shard k of n
rusty test --reporter junit=PATHWrite JUnit XML report
rusty test --retries NRe-run failed test binaries up to N times
rusty add <crate> [--vers REQ]Add dependency (native for rusty.json)
rusty rm, updateDependency verbs (passthrough)
rusty install <crate>[@version]Prebuilt binary when available, else cargo install

init kinds

web, cli, tui, lib, fullstack, blank

Content store

CommandDescription
rusty store pathPrint store root
rusty store statsBlob count + size
rusty store put <file>Ingest file, print digest
rusty store get <digest>Dump blob to stdout
rusty store has <digest>Exit 0 if present
rusty store gc [--dry-run] [--keep-ref <id>]Reclaim unreferenced blobs
rusty store tree put <dir>Ingest directory tree
rusty store tree get <hex> <dest>Materialize tree
rusty store tree ls <hex>List tree entries
rusty store crate ingest <n> <v> <src>Ingest .crate tarball
rusty store crate materialize <n> <v> <dest>Extract crate to path
rusty store crate listList ingested crates

Build layers

CommandDescription
rusty layers list [--profile p]Cached crate layers
rusty layers plan [--profile p]Forecast hit/miss
rusty layers why <id> [--profile p]Layer key for name@version

Build cache

CommandDescription
rusty cache pathArtifact cache root
rusty cache key [--source <hex>] ...Artifact key for inputs
rusty cache put <key-hex> <out-dir>Store artifact group
rusty cache get <key-hex> <dest>Restore artifact group
rusty cache has <key-hex>Exit 0 if cached
rusty cache statsArtifact statistics
rusty cache wrapRUSTC_WRAPPER entry (via rusty-wrapper)

Proxy

Put $RUSTY_HOME/bin on PATH after rusty env use. Shims dispatch cargo, rustc, rustdoc, etc. Override with +toolchain or RUSTY_TOOLCHAIN.

CommandDescription
rusty proxy <prog> [args...]Exec active toolchain binary

Workspace

CommandDescription
rusty workspace listList workspace members
rusty workspace affected [base]Crates changed since <base>
rusty workspace affected --reverseInclude reverse dependents
rusty workspace dependents <crate>Who depends on <crate>
rusty workspace unifyVersion-drift report
rusty workspace test-plan [base]Print rusty test -p … for affected set (same packages as --affected)

Cargo passthrough

These verbs spawn cargo with rusty-managed environment when applicable:

build, run, check, clippy, fmt, doc, bench, tree, and other unrecognized commands.

Build-related passthrough runs fetch preparation, sets CARGO_HOME, CARGO_TARGET_DIR, RUSTC_WRAPPER, and passes --offline when sources are prepared.

On this page