rux new
Purpose
Create a new Rux package in a new directory
Synopsis
rux new [name] [options]
Behavior
Creates a new directory containing a manifest and starter source. --executable, --shared, --static, and --source are mutually exclusive; Executable is the default. --path selects the parent directory and --namespace sets the registry namespace.
Arguments
| Argument | Required | Description |
|---|---|---|
name | Yes | The package or dependency name |
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 |
--path <dir> | Create the workspace in a specific directory |
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 new App
rux new App --executable
rux new Io --shared --namespace Rux
rux new Math --static
rux new Json --source
Environment variables
This command defines no command-specific environment variables.
The global color environment behavior is described under Global options.