👷‍♂️ Builder

Builder is a tool that implements the builder specification. It is the specification to build and deploy software projects with agents. It has a server and a CLI.

🤹‍♀️ This is inspired by quick from Shopify and Magic by WealthSimple.

Warning

There will be an upcoming change to a full rename to sparkles. This will effect the CLI and configuration.

🔧 Usage

• 👨‍🎨 Design
• 🏗️ Build
• 🚢 Ship

sparkles help

📦 Installation

brew install zeiss/builder-tap/sparkles

⛑️ Upgrade

brew upgrade zeiss/builder-tap/sparkles

Features

• 🏛️ Static site hosting
• 🧭 Spec-driven building
• ...

🗺️ Discovery

The configuration for the authentication provider and the API can be served on a .well-known/builder-configuration endpoint.

GET /.well-known/builder-configuration

{
  "oidc_issuer": "http://builder.internal:5556/dex",
  "api_url": "http://builder.internal:5556"
}

This is a way to simplify the configuration.

Authentication

The builder authenticates to the server using OpenID Connect. The authentication flow is handled by the server. It supports dex as an OpenID Connect provider.

To authenticate, builder uses a dex client ID and secret. These are configured in the builder tool.

sparkles account login --url <builder-server>

This logs you in to the builder server.

sparkles --help

There are a couple of basic features.

  sparkles

  USAGE


    sparkles [command] [--flags]


  COMMANDS

    account [command]     Manage accounts
    check                 Check the configuration
    completion [command]  Generate the autocompletion script for the specified shell
    help [command]        Help about any command
    init                  Initialize a new config
    reset                 Reset the configuration
    sites [command]       Manages sites

  FLAGS

    -c --config           Config file (.builder.yml)
    --continue            Continue
    --debug               Debug mode
    --experimental        Experimental mode
    -f --force            Force init
    -h --help             Help for sparkles
    -p --path             Path (.sparkles)
    --plugin              Plugin
    -s --session          Session
    -u --url              Url
    --var                 Variables
    -v --verbose          Verbose output
    --version             Version for sparkles
    -y --yolo             Yolo mode

Server

The server implements the deployment features of the builder specification.

Using Helm to run the builder on Kubernetes.

helm repo add builder https://zeiss.github.io/builder
helm repo update
helm search repo builder

License

Apache 2.0