Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

sysand add

Add usage to project information.

Usage

sysand add [OPTIONS] <IRI|--path <PATH>> [VERSION_CONSTRAINT]

Description

Adds IRI and optional version constraint to list of usages in the project information file .project.json. By default this will also update the lockfile and sync the local environment (creating one if not already present).

When adding a usage with one of the --from-* or --as-* flags the configuration file will be automatically updated with a project source override as described in Dependencies. If one of the --from-* flags are used, Sysand will attempt to guess the type of project source, while the --as-* flags let you specify the type explicitly. Sysand cannot determine if a project is to be editable, so for that you need to specify the path with the --as-editable flag.

The affected configuration file will either be the one given with --config-file or (if --no-config is not present) the sysand.toml at the root of the project. If no configuration file is given and --no-config is set, the usage will be added to the project, but no source will be configured, so future syncing will not take this into account.

Arguments

  • <IRI>: IRI/URI/URL identifying the project to be used. See usage field for details.
  • [VERSION_CONSTRAINT]: A constraint on the allowable versions of a used project. Assumes that the project uses Semantic Versioning. See versionConstraint for details

Options

  • -p, --path <PATH>: Path to the project to be added. Since every usage is identified by an IRI, file:// URL will be used to refer to the project.

    Warning: using this makes the project not portable between different computers, as file:// URL always contains an absolute path

  • --no-lock: Do not automatically resolve usages (and generate lockfile)

  • --no-sync: Do not automatically install dependencies

  • --from-path <PATH>: Add usage as a local interchange project at PATH and update configuration file attempting to guess the source from the PATH

  • --from-url <URL>: Add usage as a remote interchange project at URL and update configuration file attempting to guess the source from the URL

  • --as-editable <PATH>: Add usage as an editable interchange project at PATH and update configuration file with appropriate source

  • --as-local-src <PATH>: Add usage as a local interchange project at PATH and update configuration file with appropriate source

  • --as-local-kpar <PATH>: Add usage as a local interchange project archive at PATH and update configuration file with appropriate source

  • --as-remote-src <URL>: Add usage as a remote interchange project at URL and update configuration file with appropriate source

  • --as-remote-kpar <URL>: Add usage as a remote interchange project archive at URL and update configuration file with appropriate source

  • --as-remote-git <URL>: Add usage as a remote git interchange project at URL and update configuration file with appropriate source

Resolution options

  • --index [<INDEX>...]: Comma-delimited list of index URLs to use when resolving project(s) and/or their dependencies, in addition to the default indexes
  • --default-index [<DEFAULT_INDEX>...]: Comma-delimited list of URLs to use as default index URLs. Default indexes are tried before other indexes (default https://beta.sysand.org)
  • --no-index: Do not use any index when resolving project(s) and/or their dependencies
  • --include-std: Don’t ignore KerML/SysML v2 standard libraries if specified as dependencies

Global options

  • -v, --verbose: Use verbose output
  • -q, --quiet: Do not output log messages
  • --no-config: Disable discovery of configuration files
  • --config-file <CONFIG_FILE>: Give path to ‘sysand.toml’ to use for configuration
  • -h, --help: Print help