buildhost

https://github.com/wow-look-at-my/buildhost
Admin
Self-hosted universal package registry that enables uploading release artifacts once and downloading...
Tokens:10,485
Snippets:132
Trust Score:4.6
License:MIT
Update:4 months ago
Show doc for...
Tokens:
Raw
### Buildhost Quick Start Commands

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Basic commands to start the buildhost server, create a token, create a project, publish an artifact, and download it.

```bash
# Start the server
buildhost serve

# Create a token (first time setup)
buildhost token create --server http://localhost:8080 --token $BOOTSTRAP_TOKEN --name ci

# Create a project
buildhost project create --server http://localhost:8080 --token $TOKEN --name myapp

# Publish an artifact
buildhost publish \
  --server http://localhost:8080 \
  --token $TOKEN \
  --project myapp \
  --os linux --arch amd64 \
  --artifact ./myapp-linux-amd64

# Download
curl -O http://localhost:8080/dl/myapp/latest/linux/amd64
```

--------------------------------

### Run BuildHost with default settings

Source: https://github.com/wow-look-at-my/buildhost/blob/master/CLAUDE.md

Starts the BuildHost server with default configurations. Services are accessed via subdomains.

```bash
BUILDHOST_LISTEN_ADDR=:8080 buildhost serve

```

--------------------------------

### Install Package with Homebrew

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Install a package managed by buildhost using Homebrew by directly providing the formula URL.

```bash
brew install __BREW_URL__/myapp
```

--------------------------------

### Install Package with npm

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Install an npm package published via buildhost by specifying the custom registry URL.

```bash
npm install @buildhost/myapp --registry __NPM_URL__
```

--------------------------------

### Add APT Repository

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Configure your system to use the buildhost APT repository by adding its source list entry and GPG key. This allows you to install packages using `apt`.

```bash
echo "deb [signed-by=/etc/apt/keyrings/myapp.gpg] __APT_URL__/myapp stable main" \
  | sudo tee /etc/apt/sources.list.d/myapp.list
sudo apt update && sudo apt install myapp
```

--------------------------------

### Serve Buildhost with OIDC Auto-Provisioning

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Starts the Buildhost server with specific OIDC issuers and allowed organizations for auto-provisioning. Ensure the BUILDHOST_OIDC_ISSUERS and BUILDHOST_OIDC_ORGS environment variables are correctly set.

```bash
BUILDHOST_OIDC_ISSUERS=https://token.actions.githubusercontent.com \
  BUILDHOST_OIDC_ORGS=wow-look-at-my,PazerOP \
  buildhost serve
```

--------------------------------

### Download Latest Build of a Branch

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Example of how to download the latest build of a specific branch using a GET request.

```http
GET /dl/myapp/branch/main/linux/amd64
```

--------------------------------

### LLMs Guide

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Serves a plain-text document explaining Buildhost for LLMs and automated agents. This endpoint is public and unauthenticated.

```APIDOC
## GET /llms.txt

### Description
Serves a plain-text document explaining Buildhost for LLMs and automated agents. This endpoint is public and unauthenticated.

### Method
GET

### Endpoint
/llms.txt
```

--------------------------------

### Publish Static Site

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Publish a static site from a local directory to buildhost. Each git branch gets an independent deployment, accessible via a dedicated URL.

```bash
buildhost publish-site --server __BASE_URL__ --token $TOKEN \
  --project myapp --branch main --dir ./dist
# served at __SITES_URL__/myapp/branch/main/
```

--------------------------------

### Buildhost API token creation response

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

This is an example of the JSON response received after creating a new token. It contains the plaintext token value and details about the token.

```json
{
  "token": "bh_plaintext_value_shown_once",
  "details": { "id": 7, "name": "ci", "scopes": "read,write", ... }
}
```

--------------------------------

### Get Project

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Retrieves details for a specific project.

```APIDOC
## GET /api/v1/projects/{project}

### Description
Retrieves details for a specific project.

### Method
GET

### Endpoint
/api/v1/projects/{project}

### Parameters
#### Path Parameters
- **project** (string) - Required - The name of the project
```

--------------------------------

### Recommended Docker Compose Configuration

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

A recommended docker-compose setup for running buildhost. Note that the admin dashboard (port 9090) requires a reverse proxy for security.

```yaml
services:
  buildhost:
    image: ghcr.io/wow-look-at-my/buildhost:latest
    ports:
      - "8080:8080"
    volumes:
      - buildhost-data:/var/lib/buildhost
    security_opt:
      - no-new-privileges:true
    cap_drop:
      - ALL
    read_only: true
    pids_limit: 256
    mem_limit: 512m
    networks:
      - buildhost

  # The admin dashboard (port 9090) has NO built-in authentication.
  # It MUST be placed behind a reverse proxy with access control
  # (e.g., Cloudflare Access on a separate hostname).
  # Do NOT expose port 9090 to untrusted networks.

networks:
  buildhost:
    driver: bridge
    internal: true

volumes:
  buildhost-data:
```

--------------------------------

### Get Release

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Retrieves details for a specific release of a project.

```APIDOC
## GET /api/v1/projects/{project}/releases/{version}

### Description
Retrieves details for a specific release of a project.

### Method
GET

### Endpoint
/api/v1/projects/{project}/releases/{version}

### Parameters
#### Path Parameters
- **project** (string) - Required - The name of the project
- **version** (string) - Required - The version of the release
```

--------------------------------

### Health check response with build information

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

The GET /healthz endpoint returns a JSON object indicating the server's status and the specific build commit and version it is running.

```json
{"status":"ok","commit":"<git-sha>","version":"v0.0.<unix>"}
```

--------------------------------

### Create Project and Publish Binary with CLI

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Use the buildhost CLI to create a new project and publish a binary artifact for a specific OS and architecture. This automatically creates the next version.

```bash
# Create a project once
buildhost project create --server __BASE_URL__ --token $TOKEN --name myapp

# Publish a binary for one OS/arch (auto-creates the next version)
buildhost publish \
  --server __BASE_URL__ --token $TOKEN \
  --project myapp --os linux --arch amd64 \
  --artifact ./myapp-linux-amd64
```

--------------------------------

### Bootstrap Buildhost to create the first admin token

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Run this command on a fresh server to generate the initial admin token. The token is printed to stdout and is not retrievable later, so store it securely.

```bash
buildhost bootstrap                    # creates token named "admin"
buildhost bootstrap --name admin-token # custom name
```

--------------------------------

### Build Command

Source: https://github.com/wow-look-at-my/buildhost/blob/master/CLAUDE.md

Use this command for building the project. It ensures proper Go toolchain usage for tidy, vet, tests, and binary creation.

```bash
go-toolchain
```

--------------------------------

### Deploying a Static Site

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Command to deploy a static site from a local directory to a specific project and branch on buildhost.

```bash
buildhost publish-site \
  --server http://localhost:8080 \
  --token $TOKEN \
  --project myapp \
  --branch main \
  --dir ./dist
```

--------------------------------

### List all tokens using Buildhost CLI

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

This command lists all available tokens. A global token is required to perform this operation.

```bash
buildhost token list --server https://buildhost.example.com --token $ADMIN_TOKEN
```

--------------------------------

### Deploy Static Site

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Deploys a static site for a given project and branch. Expects a tar.gz file in the request body.

```APIDOC
## PUT /sites/{project}/branch/{branch}

### Description
Deploys a static site for a given project and branch. Expects a tar.gz file in the request body.

### Method
PUT

### Endpoint
/sites/{project}/branch/{branch}

### Parameters
#### Path Parameters
- **project** (string) - Required - The name or ID of the project.
- **branch** (string) - Required - The branch to deploy.
```

--------------------------------

### Bootstrap Initial Admin Token

Source: https://github.com/wow-look-at-my/buildhost/blob/master/CLAUDE.md

Creates the initial administrator token. This command only works when no other tokens exist in the system. You can optionally specify a name for the token.

```bash
buildhost bootstrap          # Creates initial admin token (only works when no tokens exist)
buildhost bootstrap --name admin-token
```

--------------------------------

### Create Project

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Creates a new project.

```APIDOC
## POST /api/v1/projects

### Description
Creates a new project.

### Method
POST

### Endpoint
/api/v1/projects
```

--------------------------------

### Create a new token using Buildhost CLI

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

This command creates a new token with specified name and scopes. Ensure the server URL and admin token are correctly provided.

```bash
buildhost token create \
  --server https://buildhost.example.com \
  --token $ADMIN_TOKEN \
  --name ci \
  --scopes read,write
```

--------------------------------

### Run BuildHost try-update CLI command

Source: https://github.com/wow-look-at-my/buildhost/blob/master/CLAUDE.md

Queries the /ready-to-update endpoint to check if the server is idle. Allows specifying a custom address.

```bash
buildhost try-update                    # queries localhost:8080/ready-to-update
buildhost try-update --addr :9090       # custom listen address

```

--------------------------------

### Publishing with the REST API

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Use the buildhost REST API to create a release, upload artifacts, and then publish the release. These endpoints manage the lifecycle of your project's releases.

```bash
POST __BASE_URL__/api/v1/projects/{project}/releases
PUT  __BASE_URL__/api/v1/projects/{project}/releases/{version}/artifacts/{os}/{arch}
POST __BASE_URL__/api/v1/projects/{project}/releases/{version}/publish
```

--------------------------------

### List Registered HTTP Routes

Source: https://github.com/wow-look-at-my/buildhost/blob/master/CLAUDE.md

Prints all registered HTTP routes for the BuildHost system, sorted for readability. This includes main-domain routes and subdomain routes with their respective host tokens.

```bash
buildhost routes   # prints all registered HTTP routes, sorted
```

--------------------------------

### Configure docker-updater for readiness check

Source: https://github.com/wow-look-at-my/buildhost/blob/master/CLAUDE.md

Sets the URL for docker-updater to check if the BuildHost server is ready for an update. Uses the main server port.

```yaml
labels:
  docker-updater.pre-check.url: "http://buildhost-backend:8080/ready-to-update"

```

--------------------------------

### Create a project-scoped read token using API

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

This API call creates a token scoped to a specific project. It requires the admin token and the project ID.

```bash
curl -X POST https://buildhost.example.com/api/v1/tokens \
  -H "Authorization: Bearer $ADMIN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "deploy-bot", "project_id": 3, "scopes": "read,write"}'
```

--------------------------------

### Publishing Docker Images with Docker CLI

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Push a Docker image to buildhost using the Docker CLI. Ensure you are logged in with a write-scoped token.

```bash
docker login builds.example.com -u oidc -p "$TOKEN"   # any username; password is a write-scoped token
docker buildx build --push -t builds.example.com/myproject:v1.2.3 .
docker pull builds.example.com/myproject:v1.2.3
```

--------------------------------

### Serve Static Site File

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Serves a specific file from a static site deployment.

```APIDOC
## GET /sites/{project}/branch/{branch}/{path}

### Description
Serves a specific file from a static site deployment.

### Method
GET

### Endpoint
/sites/{project}/branch/{branch}/{path}

### Parameters
#### Path Parameters
- **project** (string) - Required - The name or ID of the project.
- **branch** (string) - Required - The branch of the site.
- **path** (string) - Required - The path to the file within the site.
```

--------------------------------

### List Projects

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Lists all available projects.

```APIDOC
## GET /api/v1/projects

### Description
Lists all available projects.

### Method
GET

### Endpoint
/api/v1/projects
```

--------------------------------

### Create a global read+write token using API

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Use this API endpoint to create a global token with read and write scopes. The token is returned in the response and should be stored securely.

```bash
curl -X POST https://buildhost.example.com/api/v1/tokens \
  -H "Authorization: Bearer $ADMIN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "ci", "scopes": "read,write"}'
```

--------------------------------

### Use a token with Basic authentication

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

This method uses Basic authentication where the token is provided as the password. The username field is ignored.

```bash
curl -u "token:$TOKEN" https://buildhost.example.com/api/v1/projects
```

--------------------------------

### Configure BuildHost admin dashboard address

Source: https://github.com/wow-look-at-my/buildhost/blob/master/CLAUDE.md

Sets the listening address for the admin dashboard. Can be set to a specific address, all interfaces, or disabled.

```bash
BUILDHOST_ADMIN_LISTEN_ADDR=:9090 buildhost serve   # listen on all interfaces (default)
BUILDHOST_ADMIN_LISTEN_ADDR= buildhost serve         # disable admin dashboard

```

--------------------------------

### Publishing Docker Images with GitHub Actions

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Use the buildhost-publish-docker GitHub Action to build and push Docker images. It authenticates using GHA OIDC tokens.

```yaml
permissions:
  id-token: write   # required to mint the OIDC token
  contents: read
steps:
  - uses: actions/checkout@v4
  - uses: wow-look-at-my/buildhost/.github/actions/buildhost-publish-docker@master
    with:
      server: https://builds.example.com   # optional, defaults to https://pazer.build
      context: .                            # optional
      # tags default to the commit SHA and "latest"; bare tags are expanded to
      # <registry>/<project>:<tag>, full references (with "/" or ":") are used as-is.
      tags: |
        ${{ github.sha }}
        latest
```

--------------------------------

### Repackage Artifact on Demand

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Repackage a downloaded artifact on the fly by specifying the desired format using the `fmt` query parameter. Supported formats include raw, tar.gz, tar.xz, tar.zst, and zip.

```bash
curl -LO "__DL_URL__/myapp?os=linux&arch=amd64&fmt=tar.gz"
```

--------------------------------

### Download Specific Version of a Project

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Download a specific version of a project artifact by providing the version number in the query parameters.

```bash
# A specific version
curl -LO "__DL_URL__/myapp?v=1&os=linux&arch=amd64"
```

--------------------------------

### Use a token with a query parameter

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

This method is suitable for clients that cannot set request headers. The token is appended as a query parameter.

```bash
curl "https://buildhost.example.com/api/v1/projects?token=$TOKEN"
```

--------------------------------

### List Tokens

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Lists all available API tokens. Requires a global token.

```APIDOC
## GET /api/v1/tokens

### Description
Lists all available API tokens. Requires a global token.

### Method
GET

### Endpoint
/api/v1/tokens

### Response
#### Success Response (200)
- (Array of token objects) - Details of each token.
```

--------------------------------

### Enable OpenTelemetry telemetry

Source: https://github.com/wow-look-at-my/buildhost/blob/master/CLAUDE.md

Enables distributed tracing and log export via OTLP/HTTP by setting the OpenTelemetry endpoint.

```bash
BUILDHOST_OTEL_ENDPOINT=https://otel.example.com buildhost serve

```

--------------------------------

### List Branch Deployments

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Lists all branch deployments for a given project.

```APIDOC
## GET /api/v1/projects/{project}/sites

### Description
Lists all branch deployments for a given project.

### Method
GET

### Endpoint
/api/v1/projects/{project}/sites

### Parameters
#### Path Parameters
- **project** (string) - Required - The name or ID of the project.
```

--------------------------------

### Create Release

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Creates a new release for a project.

```APIDOC
## POST /api/v1/projects/{project}/releases

### Description
Creates a new release for a project.

### Method
POST

### Endpoint
/api/v1/projects/{project}/releases

### Parameters
#### Path Parameters
- **project** (string) - Required - The name of the project
```

--------------------------------

### Download Latest Version of a Project

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Download the latest version of a project artifact for a specific OS and architecture using curl. The version defaults to latest when omitted.

```bash
# The latest version (version defaults to latest when omitted)
curl -LO __DL_URL__/myapp?os=linux&arch=amd64
```

--------------------------------

### REST API Endpoints

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

This table lists the available API routes for project and release management, artifact uploads, and health checks. Use concrete versions for project-related calls.

```bash
POST   /api/v1/projects                                                      create project
GET    /api/v1/projects                                                      list projects
GET    /api/v1/projects/{project}                                            get project
POST   /api/v1/projects/{project}/releases                                   create release
GET    /api/v1/projects/{project}/releases                                   list releases
GET    /api/v1/projects/{project}/releases/{version}                         get release
PUT    /api/v1/projects/{project}/releases/{version}/artifacts/{os}/{arch}   upload artifact
POST   /api/v1/projects/{project}/releases/{version}/publish                 publish release
GET    /healthz                                                              health check
```

--------------------------------

### Health Check

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Performs a liveness check on the Buildhost server, including a database ping. Returns server build information.

```APIDOC
## GET /healthz

### Description
Performs a liveness check on the Buildhost server, including a database ping. Returns server build information.

### Method
GET

### Endpoint
/healthz

### Response
#### Success Response (200)
- **status** (string) - "ok" if the server and database are reachable.
- **commit** (string) - The git commit SHA of the running build.
- **version** (string) - The version of the running build.
#### Error Response (503)
- **status** (string) - "error" if the database is unreachable.
- **commit** (string) - The git commit SHA of the running build.
- **version** (string) - The version of the running build.
```

--------------------------------

### List Releases

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Lists all releases for a project.

```APIDOC
## GET /api/v1/projects/{project}/releases

### Description
Lists all releases for a project.

### Method
GET

### Endpoint
/api/v1/projects/{project}/releases

### Parameters
#### Path Parameters
- **project** (string) - Required - The name of the project
```

--------------------------------

### Download Latest Artifact

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Downloads the latest artifact for a project, OS, and architecture.

```APIDOC
## GET /dl/{project}/latest/{os}/{arch}

### Description
Downloads the latest artifact for a project, OS, and architecture.

### Method
GET

### Endpoint
/dl/{project}/latest/{os}/{arch}

### Parameters
#### Path Parameters
- **project** (string) - Required - The name or ID of the project.
- **os** (string) - Required - The operating system.
- **arch** (string) - Required - The architecture.
```

--------------------------------

### Create OIDC Policy

Source: https://github.com/wow-look-at-my/buildhost/blob/master/CLAUDE.md

Creates an OIDC policy granting read/write access to a specific project ID for workflows matching a given repository pattern. Requires an admin token for authorization.

```bash
curl -X POST https://buildhost.example.com/api/v1/oidc/policies \
  -H "Authorization: Bearer $ADMIN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"issuer":"https://token.actions.githubusercontent.com","subject_pattern":"repo:myorg/myrepo:*","project_id":1,"scopes":"read,write"}'
```

--------------------------------

### Pull OCI / Docker Image

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Pull an OCI or Docker image from a buildhost registry by specifying the registry host and image tag.

```bash
docker pull __OCI_HOST__/myapp:latest
```

--------------------------------

### Create Token

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Creates a new API token. Tokens can be global or project-scoped and have specific scopes (read, write).

```APIDOC
## POST /api/v1/tokens

### Description
Creates a new API token. Tokens can be global or project-scoped and have specific scopes (read, write).

### Method
POST

### Endpoint
/api/v1/tokens

### Parameters
#### Request Body
- **name** (string) - Required - The name of the token.
- **scopes** (string) - Optional - The scopes for the token (e.g., "read,write"). Defaults to "read".
- **project_id** (integer) - Optional - The ID of the project to scope the token to.

### Request Example
```json
{
  "name": "ci",
  "scopes": "read,write"
}
```

### Response
#### Success Response (200)
- **token** (string) - The generated token value (plaintext, shown once).
- **details** (object) - Information about the created token (id, name, scopes, etc.).
```

--------------------------------

### Upload Artifact

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Uploads an artifact for a specific release, OS, and architecture.

```APIDOC
## PUT /api/v1/projects/{project}/releases/{version}/artifacts/{os}/{arch}

### Description
Uploads an artifact for a specific release, OS, and architecture.

### Method
PUT

### Endpoint
/api/v1/projects/{project}/releases/{version}/artifacts/{os}/{arch}

### Parameters
#### Path Parameters
- **project** (string) - Required - The name or ID of the project.
- **version** (string) - Required - The version of the release.
- **os** (string) - Required - The operating system.
- **arch** (string) - Required - The architecture.
```

--------------------------------

### Download Artifact

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Downloads a specific artifact for a project and version.

```APIDOC
## GET /dl/{project}/{version}/{os}/{arch}

### Description
Downloads a specific artifact for a project and version.

### Method
GET

### Endpoint
/dl/{project}/{version}/{os}/{arch}

### Parameters
#### Path Parameters
- **project** (string) - Required - The name or ID of the project.
- **version** (string) - Required - The version of the artifact.
- **os** (string) - Required - The operating system.
- **arch** (string) - Required - The architecture.
```

--------------------------------

### Download Latest Artifact for Branch

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Downloads the latest artifact for a project, OS, and architecture for a specific branch.

```APIDOC
## GET /dl/{project}/branch/{branch}/{os}/{arch}

### Description
Downloads the latest artifact for a project, OS, and architecture for a specific branch.

### Method
GET

### Endpoint
/dl/{project}/branch/{branch}/{os}/{arch}

### Parameters
#### Path Parameters
- **project** (string) - Required - The name or ID of the project.
- **branch** (string) - Required - The branch name.
- **os** (string) - Required - The operating system.
- **arch** (string) - Required - The architecture.
```

--------------------------------

### Use a token with Bearer authentication

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

This is the preferred method for authenticating API requests using a token. It involves setting the Authorization header.

```bash
curl -H "Authorization: Bearer $TOKEN" https://buildhost.example.com/api/v1/projects
```

--------------------------------

### Configure docker-updater for rolling updates

Source: https://github.com/wow-look-at-my/buildhost/blob/master/CLAUDE.md

Enables docker-updater and configures it for rolling updates, allowing for zero-downtime deployments. Sets a graceful shutdown period.

```yaml
labels:
  docker-updater.enable: "true"
  docker-updater.rolling: "true"
stop_grace_period: 5m

```

--------------------------------

### Run BuildHost disabling storage compression

Source: https://github.com/wow-look-at-my/buildhost/blob/master/CLAUDE.md

Disables application-level zstd compression. Useful on filesystems with their own compression.

```bash
BUILDHOST_STORAGE_COMPRESS=false buildhost serve

```

--------------------------------

### Download Latest Build of a Git Branch

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Download the latest build artifact for a specified git branch using the download URL.

```bash
# The latest build of a git branch
curl -LO "__DL_URL__/myapp?branch=main&os=linux&arch=amd64"
```

--------------------------------

### Request OIDC Token and Access Project API

Source: https://github.com/wow-look-at-my/buildhost/blob/master/CLAUDE.md

Requests an OIDC token from BuildHost within a GitHub Actions workflow and uses it to access project information. Ensure the workflow has 'id-token: write' permissions.

```yaml
permissions:
  id-token: write
steps:
  - uses: actions/github-script@v7
    id: token
    with:
      script: return await core.getIDToken('https://buildhost.example.com')
  - run: |
      curl -H "Authorization: Bearer ${{ steps.token.outputs.result }}" \
        https://buildhost.example.com/api/v1/projects
```

--------------------------------

### Upload Artifact

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Uploads an artifact for a specific release.

```APIDOC
## PUT /api/v1/projects/{project}/releases/{version}/artifacts/{os}/{arch}

### Description
Uploads an artifact for a specific release.

### Method
PUT

### Endpoint
/api/v1/projects/{project}/releases/{version}/artifacts/{os}/{arch}

### Parameters
#### Path Parameters
- **project** (string) - Required - The name of the project
- **version** (string) - Required - The version of the release
- **os** (string) - Required - The operating system of the artifact
- **arch** (string) - Required - The architecture of the artifact
```

--------------------------------

### Regenerate SQL Queries

Source: https://github.com/wow-look-at-my/buildhost/blob/master/CLAUDE.md

Regenerates database query code using sqlc. This command should be run after editing queries in the internal/db/queries/ directory.

```bash
sqlc generate
```

--------------------------------

### Publish Release

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Publishes a release for a project.

```APIDOC
## POST /api/v1/projects/{project}/releases/{version}/publish

### Description
Publishes a release for a project.

### Method
POST

### Endpoint
/api/v1/projects/{project}/releases/{version}/publish

### Parameters
#### Path Parameters
- **project** (string) - Required - The name of the project
- **version** (string) - Required - The version of the release
```

--------------------------------

### Remove Static Site

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Removes a static site deployment for a given project and branch.

```APIDOC
## DELETE /sites/{project}/branch/{branch}

### Description
Removes a static site deployment for a given project and branch.

### Method
DELETE

### Endpoint
/sites/{project}/branch/{branch}

### Parameters
#### Path Parameters
- **project** (string) - Required - The name or ID of the project.
- **branch** (string) - Required - The branch to remove.
```

--------------------------------

### Delete a branch deployment using curl

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Use this command to remove a deployed static site for a specific branch. Ensure you have the necessary authentication token.

```bash
curl -X DELETE -H "Authorization: Bearer $TOKEN" \
  http://localhost:8080/sites/myapp/branch/main
```

--------------------------------

### Health Check

Source: https://github.com/wow-look-at-my/buildhost/blob/master/internal/llms/template.md

Checks the health status of the server.

```APIDOC
## GET /healthz

### Description
Checks the health status of the server.

### Method
GET

### Endpoint
/healthz
```

--------------------------------

### Delete a token by ID using curl

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

This command deletes a specific token using its ID. A global token is required, and you cannot delete your own token.

```bash
curl -X DELETE https://buildhost.example.com/api/v1/tokens/7 \
  -H "Authorization: Bearer $ADMIN_TOKEN"
```

--------------------------------

### Delete Token

Source: https://github.com/wow-look-at-my/buildhost/blob/master/README.md

Deletes an API token by its ID. Requires a global token and cannot delete the token used for the request.

```APIDOC
## DELETE /api/v1/tokens/{id}

### Description
Deletes an API token by its ID. Requires a global token and cannot delete the token used for the request.

### Method
DELETE

### Endpoint
/api/v1/tokens/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the token to delete.
```
Tokens:
Raw