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 publish

Publish a KPAR to a sysand package index.

Usage

sysand publish --index <URL> [PATH]

Description

Publishes a .kpar file to a sysand-compatible package index. The project must be built first using sysand build.

Authentication is required. See Authentication for how to configure credentials. For sysand publish, only bearer token credentials (SYSAND_CRED_<X>_BEARER_TOKEN) are used. If no matching bearer token credentials are configured for the publish URL, the command fails before making the upload request.

--index is required for sysand publish.

The package identifier used during publish is derived from project metadata. Before publishing, ensure publisher, name, version, and license follow these rules:

  • publisher: 3-50 characters, ASCII letters and numbers only, with optional single spaces or hyphens between words, and must start and end with a letter or number.
  • name: 3-50 characters, ASCII letters and numbers only, with optional single spaces, hyphens, or dots between words, and must start and end with a letter or number.
  • version: must be a valid Semantic Versioning 2.0 version.
  • license: required and must be a valid SPDX license expression. See Project metadata: license for examples.

name dots are preserved in the published identifier (they are not normalized away).

Arguments

  • [PATH]: Path to the .kpar file to publish. If not provided, looks for a KPAR in the output directory matching the current project’s name and version (e.g. output/<name>-<version>.kpar).

Options

  • --index <URL>: URL of the package index to publish to. Required. Provide the index root URL (for example, https://sysand.org or https://my-index.example.com/index), not the upload endpoint path (/api/v1/upload).

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

Examples

Build and publish the current project:

sysand build
sysand publish --index https://sysand.org

Publish a specific KPAR file:

sysand publish --index https://sysand.org ./my-project-1.0.0.kpar

Publish to a custom index:

sysand publish --index https://my-index.example.com

See Also