yarn pack

generate a tarball from the active workspace

Usage

yarn pack

Examples

Create an archive from the active workspace :

yarn pack

List the files that would be made part of the workspace’s archive :

yarn pack --dry-run

Name and output the archive in a dedicated folder :

yarn pack --out /artifacts/%s-%v.tgz

Details

This command will turn the active workspace into a compressed archive suitable for publishing. The archive will by default be stored at the root of the workspace (package.tgz).

If the -o,--out is set the archive will be created at the specified path. The %s and %v variables can be used within the path and will be respectively replaced by the package name and version.

Options

Definition	Description
—install-if-needed	Run a preliminary yarn install if the package contains build scripts
-n,—dry-run	Print the file paths without actually generating the package archive
—json	Format the output as an NDJSON stream
-o,—out #0	Create the archive at the specified path