Skip to main content

Publishing to the Registry

The BRIK-64 registry hosts certified PCD packages — polymers and policy circuits that have been verified (Φ_c = 1) and are available for reuse.

Prerequisites

1
Register for an API Key
2
Create an account at brik64.dev/register and generate an API key from your dashboard.
3
Authenticate the CLI
4
brikc registry login <your-api-key>
5
This stores your credentials in ~/.brik64/credentials.toml. The token is used for all registry operations.
6
Initialize Your Package
7
brikc pkg init
8
This creates a brik.toml manifest in the current directory:
9
[package]
name = "my-package"
version = "0.1.0"
description = "A brief description of your package"
author = "your-username"
license = "BSL-1.1"

[dependencies]
# other-package = "^1.0.0"

[certification]
phi_c = true          # requires Φ_c = 1
min_coverage = 100    # percentage of paths tested
10
Write Your PCD Circuit
11
Create .pcd files in your project. Every circuit must pass verification before publishing.
12
Publish
13
brikc pkg publish
Publishing runs brikc policy verify (or brikc compile --verify) on every .pcd file in the package. If any circuit fails Φ_c = 1 verification, the publish is rejected.

Registry CLI Commands

# Search by keyword
brikc registry search "crypto"

# Search by family
brikc registry search --family crypto

# Search by author
brikc registry search --author brik64-admin

Package Info

# View package details
brikc registry info crypto-utils

# View a specific version
brikc registry info crypto-utils@1.2.0
Example output:
crypto-utils v1.2.0
  Author:       brik64-admin
  License:      BSL-1.1
  Φ_c:          1 (certified)
  Monomers:     SHA256, AES_ENC, AES_DEC, HMAC
  Downloads:    1,247
  Published:    2026-03-15

Install a Dependency

brikc pkg add crypto-utils@^1.0.0
This updates your brik.toml and downloads the package to .brik64/deps/.

Certification Badges

Every published package displays a certification badge based on its verification status:
BadgeMeaning
CertifiedAll circuits pass Φ_c = 1, 100% path coverage
VerifiedAll circuits pass Φ_c = 1, partial coverage
UnverifiedPublished but not yet certified
Aim for Certified status. Packages with full certification appear first in search results and are trusted by default in policy-restricted environments.

Embedding Badges

Use the badge URL in your README or documentation:
![BRIK-64 Certified](https://registry.brik64.dev/badge/my-package/certified.svg)

Versioning Strategy

BRIK-64 packages follow Semantic Versioning:
  • MAJOR — breaking changes to circuit interface (renamed inputs/outputs, removed circuits)
  • MINOR — new circuits or new parameters with defaults (backward compatible)
  • PATCH — bug fixes, documentation, internal improvements
Because PCD circuits are formally verified, a breaking change means the interface changed — the behavior of existing circuits must remain identical (same input → same output) across MINOR and PATCH versions.

Version Constraints in brik.toml

[dependencies]
crypto-utils = "^1.0.0"    # >=1.0.0, <2.0.0
string-tools = "~0.3.0"    # >=0.3.0, <0.4.0
my-policy    = "=2.1.0"    # exactly 2.1.0

Publishing Checklist

Before running brikc pkg publish, verify:
  • All .pcd files compile without errors
  • brikc policy verify passes on all circuits (Φ_c = 1)
  • brik.toml has correct name, version, description, and author
  • Version number is bumped from the previous release
  • No secrets or credentials in the package files