sysand init#

Create a new project

Usage#

sysand init [OPTIONS] --publisher <PUBLISHER> [PATH]

Description#

Create a new project, i.e. create .project.json and .meta.json files. --publisher is required; the command fails without it.

Arguments#

  • [PATH]: The path to use for the project. The project is created at this path (the directory is created if it does not exist). Defaults to current directory

Options#

  • --publisher <PUBLISHER>: Required. The publisher of the project: the person, team, or organization developing it. Together with the name it is how other projects refer to this one when adding it as a usage (dependency)

  • --name <NAME>: The name of the project. Defaults to the directory name

  • --version <VERSION>: Set the version in SemVer 2.0 format. Defaults to 0.0.1

  • --no-semver: Don’t require version to conform to SemVer. Requires --version

  • --license <LICENSE>: Set the license in the form of an SPDX license identifier. Defaults to omitting the license field

  • --no-spdx: Don’t require license to be an SPDX expression. Requires --license

Errors#

Init aborts if the version is not a valid SemVer 2.0 version (without --no-semver) or if the license is not a valid SPDX expression (without --no-spdx).

Global options#

  • -v, --verbose: Use verbose output

  • -q, --quiet: Do not output log messages

  • --no-config: Disable discovery of configuration files [env: SYSAND_NO_CONFIG]

  • --config-file <CONFIG_FILE>: Give path to sysand.toml to use for configuration [env: SYSAND_CONFIG_FILE]

  • -h, --help: Print help