Installation - 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

Installation

Install Buffrs

The easiest way to get buffrs is to install the current stable release from crates.io using:

cargo install buffrs

As of right now you are required to authenticate yourself against your private artifactory instance (which will be replaced by the Buffrs Registry in Q4 2023).

Logging in to your instance is done using the following buffrs command:

buffrs login --registry https://<organization>.jfrog.io/artifactory

You will be prompted for an artifactory identity token which you can create within the artifactory user interface or programmatically through terraform.

Build and Install Buffrs from Source

As alternative installation method you can clone the Buffrs Repository and install it locally using Cargo (cargo install --path .).