packslip install
- Usage:
packslip install [FLAGS] <PROJECT>
Install a verified release and export its declared commands
Find the release a project's name leads to, and verify its release bundle and the artifact for this host. Unpack the archive into an installation tree and export the commands the release declares.
A github.com project must be signed from its repository. A keyless domain project's first install trusts the signer that its release list and release bundle declare, fetched over HTTPS from that host. A key-signed domain project needs --pubkey on its first install. Later installs hold the project to what was accepted, and a keyless domain project to the repository that signed it. A changed signer or signing repository, keyless signing replaced by a key, disabled workflow pinning, a repackager's bundle after the vendor's, or dropped provenance needs --accept-trust-change, and a github.com name that now resolves to a different repository ID is refused. --pin, --issuer, --identity, and --identity-prefix narrow what the project's name requires and never replace it. gitlab.com projects are refused.
The command runs no downloaded code, installs no dependencies, and edits no shell configuration. There is no uninstall, upgrade, or list. It prints the installed version and tree, Signer fingerprint: ps1_... for a github.com project, and each command. It warns when the project's release list withdraws the release it last installed. See https://packslip.dev/docs/bootstrap/
Arguments
<PROJECT>— The project: owner/repo, github.com/owner/repo[/TOOL], or a domain project such as mytool.example.com[/PATH]
Flags
--version <VERSION>— Version, prefix, range, tag, or latest (the default)latest takes the vendor's recommended release, otherwise the highest stable version. When that release carries no packslip for the project or no artifact for this host, install tries the other stable releases from the highest down. It warns about each release it skips. It examines the first release in full, and stops before a later release would bring the bundles it fetched past 32. A version (1.2.3 also matches 1.2.3+build.5), prefix (1.2), or range (^1.2) skips only releases without a packslip for the project; a tag tries only that release. Host requirements never select a different release.
--system— Install for all usersThe default for root on Unix. Conflicts with --user.
--user— Install for the current userThe default, except for root on Unix, which cannot select it. Conflicts with --system.
--force— Replace conflicting command entries and installation directoriesAn installation directory conflicts when it is unmarked or belongs to another project. Verification and trust-change approval still apply.
--offline— Use only locally cached, authenticated metadata and artifactsMakes no network requests, and fails when something is not cached.
--install-dir <INSTALL_DIR>— Install into this absolute directory instead of the scope's treeTrust state stays in the scope.
--bin-dir <BIN_DIR>— Export commands into this absolute directory instead of the scope'sTrust state stays in the scope.
--variant <VARIANT>— Select the artifact the publisher marks with this variant name--pin <PIN>— Require this signer fingerprint (ps1_...), aspackslip pinprints it (repeatable)A signer with any of the given fingerprints is accepted.
--pubkey <PUBKEY>— Require this public key: a minisign .pub file, such as one frompackslip keygen, or its base64 lineA key-signed domain project's first install needs it, and later installs remember it. A github.com project refuses it, since it must be signed keyless.
--issuer <ISSUER>— Require this OIDC issuerIt narrows what the project's name requires and never replaces it.
--identity <IDENTITY>— Require this exact certificate identity, ref included, such as https://github.com/owner/repo/.github/workflows/release.yml@refs/tags/v1.2.3It narrows what the project's name requires and never replaces it. A GitHub or GitLab repository name in it matches in any case; the rest matches exactly.
--identity-prefix <IDENTITY_PREFIX>— Require a certificate identity that starts with this prefix, such as https://github.com/owner/repo/It narrows what the project's name requires and never replaces it. A GitHub or GitLab repository name in it matches in any case; the rest matches exactly.
--accept-trust-change <ACCEPT_TRUST_CHANGE>— Approve one trust change by the ID install printed for it (repeatable)The ID covers that exact release bundle or release list, the signer accepted before, and the trust requirements in effect, so it approves nothing else.
--trusted-root <TRUSTED_ROOT>— Use this Sigstore trusted_root.json instead of refreshing the trust root through TUF--allow-unlogged— Accept a bundle without a transparency log entry, such as one created with --key --no-logApplies to this install only.
--allow-incompatible-host— Install even when this host does not meet the selected artifact's host requirements--max-extracted-size <MAX_EXTRACTED_SIZE>— The most bytes an archive may expand toDefault:
10737418240--max-archive-entries <MAX_ARCHIVE_ENTRIES>— The most entries an archive may holdDefault:
100000-h --help— Print help
Examples
Install the latest release of hk
packslip install github.com/jdx/hk
Install hk 2.8.0 and require its signer fingerprint
packslip install github.com/jdx/hk \
--version 2.8.0 \
--pin ps1_snirenkjwr7m5ozgcufameodnm
Install a key-signed domain project
packslip install mytool.example.com --pubkey release.pub