Getting Started with cvcpkg

curl -fsSL https://cvcpkg.org/install.sh | sh

irm https://cvcpkg.org/install.ps1 | iex

pip install cvcpkg

git clone https://github.com/transfix/libcvc-deps.git
cd cvcpkg
pip install .

cvcpkg --version

# Install zlib into ./deps
cvcpkg install zlib --prefix ./deps

# Install multiple packages
cvcpkg install boost hdf5 fftw3 --prefix ./deps

# Release + shared (default)
cvcpkg install qt6 --prefix ./deps

# Debug + static
cvcpkg install qt6 --prefix ./deps --config debug --link static

cvcpkg list --prefix ./deps

# Detects CMake, autotools, Meson, a plain Makefile, or Python packaging
cvcpkg generate .

# Or scaffold a blank one to fill in by hand
cvcpkg init myapp

depends:
  build:
    - name: boost
      version: ">=1.86"
    - name: hdf5
    - name: qt6
    - name: vtk
  host_tools:
    - cmake
    - ninja

cvcpkg install-deps myapp --prefix ./deps
cvcpkg build myapp --prefix ./deps

cvcpkg lock     # creates cvc-lock.yaml
cvcpkg sync     # installs exactly what's in the lockfile
cvcpkg verify   # check the prefix still matches the lockfile

cmake -B build \
  -DCMAKE_PREFIX_PATH=$(pwd)/deps \
  -DCMAKE_BUILD_TYPE=Release

find_package(Boost REQUIRED COMPONENTS system filesystem)
find_package(HDF5 REQUIRED COMPONENTS CXX)
find_package(Qt6 REQUIRED COMPONENTS Core Gui Widgets)
find_package(VTK REQUIRED)

mkdir -p recipes/mylib
cd recipes/mylib

schema_version: 1

recipe:
  name: mylib
  upstream_version: "2.1.0"
  cvc_revision: 1
  maintainer: "Your Name"
  maintainer_email: "you@example.com"
  description: "A great library"
  homepage: https://example.com/mylib
  license: MIT
  tags: [utils, io]

source:
  type: tarball
  url: https://example.com/mylib-2.1.0.tar.gz
  sha256: abc123...   # required for tarball sources
  strip_components: 1

depends:
  build:
    - name: zlib      # build-time dependency
    - name: boost
      version: ">=1.86"
  host_tools:
    - cmake
    - ninja

build:
  matrix:
    - platform: linux
      script: build.sh
    - platform: macos
      script: build.sh
    - platform: windows
      script: build.ps1

package:
  files:
    - lib/libmylib*
    - include/mylib/**
  cmake_packages:
    - { name: mylib, targets: [mylib::mylib] }

test:
  script: test.sh

#!/usr/bin/env bash
set -euo pipefail

cmake -S "$CVC_SOURCE_DIR" -B "$CVC_BUILD_DIR" -G Ninja \
  -DCMAKE_INSTALL_PREFIX="$CVC_INSTALL_DIR" \
  -DCMAKE_PREFIX_PATH="$CVC_DEPS_PREFIX" \
  -DCMAKE_BUILD_TYPE="$CMAKE_BUILD_TYPE" \
  -DBUILD_SHARED_LIBS="$BUILD_SHARED_LIBS"

cmake --build "$CVC_BUILD_DIR" --parallel
cmake --install "$CVC_BUILD_DIR"

# Validate recipe.yaml schema
cvcpkg validate recipes/mylib

# Build and package
cvcpkg build recipes/mylib --prefix ./deps

# The archive is written to dist/
ls dist/mylib-*.tar.gz

cvcpkg login --server https://cvcpkg.org

# force the device-code flow (no local browser)
cvcpkg login --server https://cvcpkg.org --code

cvcpkg auth providers
cvcpkg login --server https://cvcpkg.org --provider ringb

cvcpkg whoami
cvcpkg auth devices     # your active sessions
cvcpkg logout

cvcpkg publish dist/mylib-2.1.0-linux-x86_64-release-shared.tar.gz \
  --server https://cvcpkg.org \
  --token cvctok_...

cvcpkg publish dist/mylib-*.tar.gz \
  --server https://cvcpkg.org \
  --token cvctok_... \
  --org my-team

cvcpkg publish dist/mylib-*.tar.gz \
  --server https://cvcpkg.org \
  --token cvctok_... \
  --release-tag v2.1.0

cvcpkg login --server https://cvcpkg.org      # once, if not already signed in
cvcpkg org create my-team --display-name "My Team"

# optional: --description, --homepage, --private (members-only visibility)

curl -X POST https://cvcpkg.org/v1/orgs \
  -H "Authorization: Bearer cvctok_..." \
  -H "Content-Type: application/json" \
  -d '{"slug": "my-team", "display_name": "My Team"}'

# add a person as a co-owner
cvcpkg org add-member my-team --user alice --role owner

# add a CI/machine token as a plain member
cvcpkg org add-member my-team --token-name acme-ci --role member

# list members (shows each one's kind: user / token / orphan)
cvcpkg org members my-team

# remove a member
cvcpkg org remove-member my-team --user alice

curl -X POST "https://cvcpkg.org/v1/orgs/my-team/members?token_name=alice&role=owner&principal_kind=user" \
  -H "Authorization: Bearer cvctok_..."

# Set to 50 GiB
curl -X PATCH https://cvcpkg.org/v1/orgs/my-team \
  -H "Authorization: Bearer cvctok_..." \
  -H "Content-Type: application/json" \
  -d '{"storage_limit_bytes": 53687091200}'

cvcpkg-server run --state-dir ./my-packages --port 8420

# from the repo root
cp .env.production.example .env.production
# Edit .env.production with your secrets
docker compose -f docker-compose.production.yml \
  --env-file .env.production up -d

# Create a publisher token
cvcpkg-server token create --name ci-bot --role publisher

# Publish an archive
cvcpkg publish my-lib-1.0-linux-x86_64-release-shared.tar.zst \
  --server http://localhost:8420 \
  --token cvctok_...

cvcpkg recipe push zlib \
  --server https://cvcpkg.org --token cvctok_...

# Or push all local recipes at once
cvcpkg recipe push-all --server https://cvcpkg.org --token cvctok_...

# Create a builder token (on the server)
cvcpkg-server token create --name builder-01 --role builder

# Start the builder worker
cvcpkg builder run \
  --server https://cvcpkg.org \
  --token cvctok_... \
  --max-jobs 2

# Single build
cvcpkg builds submit zlib --platform linux --arch x86_64 \
  --server https://cvcpkg.org --token cvctok_...

# DAG build (resolves dependencies automatically)
cvcpkg builds submit-dag tiff --platform linux --arch x86_64 \
  --server https://cvcpkg.org --token cvctok_...

# List recent builds
cvcpkg builds list --server https://cvcpkg.org --token cvctok_...

# Or visit the web dashboard:
#   /builders  — registered builders and status
#   /builds    — all build jobs with filters
#   /build/42  — single build with live log