spin must be used with a subcommand.
The available subcommands are:
config- Update the current user's configurationgen- Generate a new component in the current projectls- List the official templatesnew- Generate a new project from a template
These options are available to all subcommands:
-
--help[=FMT] (default=auto)Show this help in format FMT. The value FMT must be one of
auto',pager',groff' orplain'. Withauto', the format ispagerorplain' whenever the TERM env var is `dumb' or undefined. -
-q, --quietBe quiet. Takes over -v and --verbosity.
-
-v, --verboseIncrease verbosity. Repeatable, but more than twice does not bring more.
-
--verbosity=LEVEL (absent=warning or SPIN_VERBOSITY env)Be more or less verbose. LEVEL must be one of
quiet',error',warning',info' or `debug'. Takes over -v. -
--versionShow version information.
spin config [OPTIONS]...
The config command prompts the user for global configuration values
that will be saved in $SPIN_CONFIG_DIR/config
(~/.config/spin/config by default).
Unless --ignore-config is used, the configuration values stored in
$SPIN_CONFIG_DIR/config will be used when creating new projects (with
new) and the user will not be prompted for configuration that have
been saved.
-
-C PATHRun as if spin was started in
PATHinstead of the current directory.
spin ls [OPTION]...
ls will list the available official template with their description.
-
-C PATHRun as if spin was started in PATH instead of the current directory.
spin new [OPTION]... TEMPLATE [PATH]
new generates projects from templates. The template can be either an official template, local directory or a remote git repository.
You can use ls to list the official templates.
-
PATHThe path where the project will be generated. If absent, the project will be generated in the current working directory.
-
TEMPLATE (required)The template to use. The template can be the name of an official template, a local directory or a remote git repository.
-
-C PATHRun as if spin was started in PATH instead of the current directory.
-
-d, --defaultUse default values without prompting when the configuration has a default value.
-
--ignore-configPrompt for values regardless of whether they are in the user's configuration file.