ContextQMD
Back to Pixi

pixi publish

docs/reference/cli/pixi/publish.md

0.77.17.3 KB
Original Source
<!--- This file is autogenerated. Do not edit manually! -->

pixi publish

Build the conda packages of a workspace and publish them to a channel.

--8<-- "docs/reference/cli/pixi/publish_extender:description"

Usage

pixi publish [OPTIONS]

Options

  • <a id="arg---target-platform" href="#arg---target-platform">--target-platform (-t) <TARGET_PLATFORM></a> : The target platform to build for (defaults to the current platform)

default: current_platform

  • <a id="arg---build-platform" href="#arg---build-platform">--build-platform <BUILD_PLATFORM></a> : The build platform to use for building (defaults to the current platform)

default: current_platform

  • <a id="arg---build-string-prefix" href="#arg---build-string-prefix">--build-string-prefix <BUILD_STRING_PREFIX></a> : An optional prefix prepended to the auto-generated build string
  • <a id="arg---build-number" href="#arg---build-number">--build-number <BUILD_NUMBER></a> : An optional override for the package's build number
  • <a id="arg---build-dir" href="#arg---build-dir">--build-dir (-b) <BUILD_DIR></a> : The directory to use for incremental builds artifacts
  • <a id="arg---clean" href="#arg---clean">--clean (-c)</a> : Whether to clean the build directory before building
  • <a id="arg---path" href="#arg---path">--path <PATH></a> : The path to a directory containing a package manifest, or to a specific manifest file
  • <a id="arg---target-channel" href="#arg---target-channel">--target-channel <TARGET_CHANNEL></a> : The target channel to publish packages to. Accepts a URL (prefix.dev, anaconda.org, cloudsmith://, s3://, quetz://, artifactory://) or a local filesystem path / file:// URL for an indexed local channel

aliases: to

  • <a id="arg---target-dir" href="#arg---target-dir">--target-dir <TARGET_DIR></a> : The local filesystem path to copy the built package(s) into (no channel indexing)
  • <a id="arg---force" href="#arg---force">--force</a> : Force overwrite existing packages
  • <a id="arg---no-skip-existing" href="#arg---no-skip-existing">--no-skip-existing</a> : Do not skip packages that already exist at the target
  • <a id="arg---dry-run" href="#arg---dry-run">--dry-run</a> : Resolve and print the publish set without building or uploading
  • <a id="arg---generate-attestation" href="#arg---generate-attestation">--generate-attestation</a> : Generate sigstore attestation (prefix.dev only)
  • <a id="arg---variant" href="#arg---variant">--variant <KEY=VALUES></a> : Override a build variant key with one or more values

May be provided more than once.

  • <a id="arg---variant-config" href="#arg---variant-config">--variant-config (-m) <FILE></a> : Path to an additional variant configuration YAML file

May be provided more than once.

  • <a id="arg---package-format" href="#arg---package-format">--package-format <PACKAGE_FORMAT></a> : Archive format and optional compression level, e.g. conda, tar-bz2, conda:max, conda:15, tar-bz2:9. Numeric ranges match rattler-build: -7..=22 for .conda, 1..=9 for .tar.bz2

Config Options

  • <a id="arg---no-config" href="#arg---no-config">--no-config</a> : Don't read system or user-level configuration files. Project-local <project>/.pixi/config.toml is still loaded

env: PIXI_NO_CONFIG

default: false

  • <a id="arg---config-file" href="#arg---config-file">--config-file <PATH></a> : Load configuration from this file instead of searching system and user-level paths. Project-local <project>/.pixi/config.toml is still merged on top

env: PIXI_CONFIG_FILE

  • <a id="arg---auth-file" href="#arg---auth-file">--auth-file <AUTH_FILE></a> : Path to the file containing the authentication token
  • <a id="arg---concurrent-downloads" href="#arg---concurrent-downloads">--concurrent-downloads <CONCURRENT_DOWNLOADS></a> : Max concurrent network requests, default is 50
  • <a id="arg---concurrent-solves" href="#arg---concurrent-solves">--concurrent-solves <CONCURRENT_SOLVES></a> : Max concurrent solves, default is the number of CPUs
  • <a id="arg---pinning-strategy" href="#arg---pinning-strategy">--pinning-strategy <PINNING_STRATEGY></a> : Set pinning strategy

options: semver, minor, major, latest-up, exact-version, no-pin

  • <a id="arg---pypi-keyring-provider" href="#arg---pypi-keyring-provider">--pypi-keyring-provider <PYPI_KEYRING_PROVIDER></a> : Specifies whether to use the keyring to look up credentials for PyPI

options: disabled, subprocess

  • <a id="arg---run-post-link-scripts" href="#arg---run-post-link-scripts">--run-post-link-scripts</a> : Run post-link scripts (insecure)
  • <a id="arg---no-symbolic-links" href="#arg---no-symbolic-links">--no-symbolic-links</a> : Disallow symbolic links during package installation

env: PIXI_NO_SYMBOLIC_LINKS

  • <a id="arg---no-hard-links" href="#arg---no-hard-links">--no-hard-links</a> : Disallow hard links during package installation

env: PIXI_NO_HARD_LINKS

  • <a id="arg---no-ref-links" href="#arg---no-ref-links">--no-ref-links</a> : Disallow ref links (copy-on-write) during package installation

env: PIXI_NO_REF_LINKS

  • <a id="arg---tls-no-verify" href="#arg---tls-no-verify">--tls-no-verify</a> : Do not verify the TLS certificate of the server
  • <a id="arg---offline" href="#arg---offline">--offline=<OFFLINE></a> : Run without network access, using only cached data. Commands fail if data is missing from the cache. Pass --offline=false to override an offline setting from the configuration

env: PIXI_OFFLINE

options: y, yes, t, true, on, 1, n, no, f, false, off, 0

  • <a id="arg---tls-root-certs" href="#arg---tls-root-certs">--tls-root-certs <TLS_ROOT_CERTS></a> : Which TLS root certificates to use: 'webpki' (bundled Mozilla roots) or 'system' (system store)

env: PIXI_TLS_ROOT_CERTS

  • <a id="arg---use-environment-activation-cache" href="#arg---use-environment-activation-cache">--use-environment-activation-cache</a> : Use environment activation cache (experimental)

Description

Build the conda packages of a workspace and publish them to a channel.

Builds every package in the workspace that opts into publishing with publish = true in its [package] section - in dependency order, so packages that depend on other workspace packages are built after them - and either uploads the artifacts to a channel (--target-channel) or copies them into a local directory (--target-dir). Every source dependency of a published package must itself opt into publishing; the publish fails otherwise. When no package opts in, the package at the current directory is published instead, as if --path . had been passed. Use --path to build and publish a single package.

Supported destinations for --target-channel (alias --to):

  • prefix.dev: https://prefix.dev/<channel-name>
  • anaconda.org: https://anaconda.org/<owner>/<label>
  • Cloudsmith: cloudsmith://<owner>/<repository>
  • S3: s3://bucket-name
  • Quetz: quetz://server/<channel>
  • Artifactory: artifactory://server/<channel>
  • Local filesystem channel (with indexing): file:///path/to/channel or a bare path

Use --target-dir <PATH> instead to copy the built package(s) into a directory without creating a channel structure.

--8<-- "docs/reference/cli/pixi/publish_extender:example"