buffrs package - The Buffrs Book

Introduction
Summary
Getting Started
1. Installation
2. First Steps with Buffrs
Buffrs Guide
Buffrs Integrations
1. Cargo
2. Poetry
3. Npm
Buffrs Migration
1. Decomposition
2. Project Setup
3. Common Issues
4. Continuous Integration
Buffrs Reference
1. Editions
2. Specifying Dependencies
3. 1. Overriding Dependencies
4. The Manifest Format
5. The Lockfile Format
6. Configuration
7. Environment Variables
8. Build Configuration
9. Publishing on buff.rs
10. Package Name Specifications
11. Protocol Buffer Rules
12. Dependency Resolution
13. SemVer Compatibility
Buffrs Registry Reference
1. Authentication
2. Ownership
3. Storage Layers
4. Public Registry (buff.rs)
5. Categories
6. Self Hosting
7. 1. Registry Index
  2. Registry Web API
  3. Creating Teams
Buffrs Commands
1. General Commands
2. 1. buffrs
  2. buffrs help
  3. buffrs version
3. Build Commands
4. 1. buffrs clean
  2. buffrs doc
  3. buffrs generate
  4. buffrs list
5. Manifest Commands
6. 1. buffrs add
  2. buffrs lock
  3. buffrs remove
  4. buffrs tree
  5. buffrs update
7. Package Commands
9. Publishing Commands
10. 1. buffrs login
  2. buffrs logout
  3. buffrs publish
  4. buffrs yank
FAQ

buffrs package

Generates a release tarball for the package in the current directory.

Synopsis

buffrs package

Options

--dry-run: prevents buffrs from actually writing the tarball to the filesystem
--output-directory: allows you to specify a directory to output the package
--set-version: allows you to override the version set in the manifest

Description

Like the publish command, the package command bundles the package's protocol buffer files and manifest into a gzip-compressed tarball. However, unlike the publish command it does not actually interact with the registry, instead it only writes the release tarball into the current directory. This is useful for manual distribution and for safely validating the package setup.