CLI Reference

The reference describes the command line interface (CLI) of rux that is the primary tool for interacting with Rux projects. It integrates all necessary components:

• Compiler
• Package manager
• Code formatter
• Dependency resolver
• Build system

All developer workflows from package creation to publishing are handled via rux.

Command Syntax

rux [command] [options] [-- args...]

Example:

rux version
rux help
rux help new
rux new App --bin
rux build --release
rux run
rux run -- arg1 arg2 ...
rux fmt

Command Summary

Command	Description
rux add	Add a dependency to the manifest
rux build	Build the current package
rux clean	Remove build artifacts
rux doc	Generate project documentation
rux fmt	Format source files and manifests
rux help	Show help information
rux init	Initialize a Rux project in the current directory
rux install	Download and build dependencies
rux new	Create a new Rux project
rux remove	Remove a dependency from the manifest
rux run	Build and run the main executable
rux test	Run all test targets
rux up	Update Rux toolchain
rux version	Show version information

Global options

Option	Description
--color	Control colored output
-h, --help	Show help information
-q, --quiet	Do not show log messages
-v, --verbose	Use verbose output
-V, --version	Show version information

Example Workflow

rux new App --bin
cd App
rux add [email protected]
rux install
rux build
rux run
rux fmt
rux test
rux clean

Planned Extensions

Command	Purpose
rux bench	Run benchmarks
rux deps	Inspect dependency graph
rux login	Authenticate with registry
rux lint	Run static analysis
rux publish	Publish package to the Rux registry
rux repl	Interactive Rux shell