rux init
Purpose
Initialize a Rux package in the current directory
Synopsis
rux init [options]
Behavior
Creates a manifest and starter source in the current directory. --executable, --shared, --static, and --source are mutually exclusive; Executable is the default. --namespace prepares a registry identity.
Arguments
This command accepts no operands.
Options
| Option | Description |
|---|---|
--executable | Create an Executable package with an entry point (default) |
--shared | Create a SharedLibrary package |
--static | Create a StaticLibrary package |
--source | Create a SourceLibrary package compiled into its dependents |
--namespace <ns> | Set the registry namespace required to publish |
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 init
rux init --executable
rux init --shared --namespace Rux
rux init --static
rux init --source
Environment variables
This command defines no command-specific environment variables.
The global color environment behavior is described under Global options.