Skip to content

vix pack

vix pack packages a Vix project into a distributable artifact.

Use it when you want to prepare a project for sharing, caching, verification, or deployment workflows.

Usage

bash
vix pack [options]

What it does

vix pack creates a package from a Vix project. By default, it packages the project into dist/<name>@<version> and optionally creates a dist/<name>@<version>.vixpkg artifact using the Vix manifest v2 format.

Basic usage

bash
vix pack
vix pack --name blog --version 1.0.0
vix pack --verbose
vix pack --no-zip

Output directory

Default output: dist/. Use --out to choose another:

bash
vix pack --out ./artifacts

Options

OptionDescription
-d, --dir <path>Project directory. Default is the current directory.
--out <path>Output directory. Default is <project>/dist.
--name <name>Package name. Default is the project folder name.
--version <ver>Package version. Default is 0.1.0.
--no-zipDo not create a .vixpkg artifact.
--no-hashDo not generate checksums.sha256.
--verboseShow copied files and signing output.
--sign[=mode]Signing mode: auto, never, or required.
-h, --helpShow command help.

Environment variables

VariableDescription
VIX_MINISIGN_SECKEYSecret key path used to sign package metadata.

Common workflows

bash
vix pack
vix pack --name blog --version 1.0.0
vix pack --no-zip
vix pack --no-hash
vix pack --verbose
vix pack --sign=never
VIX_MINISIGN_SECKEY=./keys/vix-pack.key vix pack --sign=required
vix pack --out ./artifacts --name blog --version 1.0.0
bash
vix build --preset release
vix check --tests
vix pack --name blog --version 1.0.0
vix verify --path ./dist/blog@1.0.0

Common mistakes

Packing before building

For release workflows, build first:

bash
vix build --preset release
vix pack --name blog --version 1.0.0

Forgetting to verify

bash
vix verify --path ./dist/blog@1.0.0

Requiring signing without a key

bash
VIX_MINISIGN_SECKEY=./keys/vix-pack.key vix pack --sign=required
CommandPurpose
vix verifyVerify a package artifact
vix cacheStore a package locally
vix buildBuild before packaging
vix checkValidate before packaging
vix taskAutomate release workflows

Next step

Continue with package verification.

Open the vix verify guide

Released under the MIT License.