Publish via CLI

Publish blueprints directly from your local machine using the Bricks CLI for quick iterations, testing, and automated workflows.

Prerequisites

• Bricks CLI installed and authenticated

• Blueprint repository with bricks.json configuration

• Required permissions to publish blueprints

Basic Publishing

Publish Current Blueprint

# Publish blueprint from current directory
bricks blueprint publish

Publish Specific Blueprint

# Publish blueprint from specific directory
bricks blueprint publish --src ./my_blueprint

Publishing Options

State File Inclusion

# Include .tfstate file for migration purposes
bricks blueprint publish --state

Non-Interactive Mode

# Suppress interactive prompts for automation
bricks blueprint publish --non-interactive

Publishing Flow

When you run bricks blueprint publish, the following happens:

1. Validation: CLI validates bricks.json configuration

2. Source Preparation: Packages blueprint source code

3. Upload: Uploads blueprint to Bluebricks platform

4. Registration: Registers blueprint in your organization

5. Confirmation: Returns success confirmation with blueprint details

Blueprint Configuration

Ensure your bricks.json includes required fields:

{
  "name": "my_blueprint",
  "version": "1.0.0",
  "description": "Blueprint description",
  "packages": {
    "terraform": {
      "type": "terraform",
      "version": "1.5.7"
    }
  },
  "inputs": {
    "environment": {
      "type": "string",
      "description": "Target environment"
    }
  },
  "outputs": {
    "endpoint": {
      "type": "string",
      "description": "Service endpoint"
    }
  }
}

Authentication

Interactive Authentication

# Login first (if not already authenticated)
bricks login

# Then publish
bricks blueprint publish

API Key Authentication

# Using environment variable
export BRICKS_API_KEY="your-api-key"
bricks blueprint publish

# Using command line flag
bricks blueprint publish --api-key "your-api-key"

Automation Examples

CI/CD Pipeline

# GitHub Actions example
- name: Publish Blueprint
  run: |
    bricks blueprint publish --non-interactive
  env:
    BRICKS_API_KEY: ${{ secrets.BRICKS_API_KEY }}

Script Automation

#!/bin/bash
set -e

# Set API key
export BRICKS_API_KEY="your-api-key"

# Publish blueprint
bricks blueprint publish --src ./blueprints/my_blueprint --non-interactive

echo "Blueprint published successfully"

Best Practices

• Version management: Use semantic versioning for blueprint versions

• Testing: Test blueprints locally before publishing

• Documentation: Include comprehensive descriptions in bricks.json

• Automation: Use API keys for CI/CD pipelines

• Validation: Always validate configuration before publishing

See also

• Creating Blueprints -- blueprint structure and web UI wizard

• How to Publish with bricks.yaml -- simplified YAML-based publishing

• How to Publish with GitHub Actions -- automated CI/CD publishing