AutoGineer
Generated banner for Boltz CLI Setup
Generated logo for Boltz CLI Setup

Boltz CLI Setup

OpenAIOfficialCreated by BoltzDistributed by OpenAI

  • Skill
  • Tool integration
  • Software development
  • MIT
  • Medium risk
Download ZIP

From the author

Boltz CLI setup and auth. Use when installing, updating, verifying, or authenticating `boltz-api`, or fixing missing CLI, PATH, sandbox, browser login, or auth errors.
— the description by Boltz

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides a structured approach to setting up and maintaining the Boltz API CLI. It covers verifying existing installations, performing new installs using official scripts, troubleshooting PATH issues, and managing user authentication via device-code login. The skill emphasizes security by requiring explicit user confirmation before executing remote installation scripts and provides guidance on handling sandbox restrictions that may interfere with browser-based authentication or local file operations.

What it does

  • Verifies the current version and installation status of the Boltz API CLI.
  • Provides secure installation procedures for macOS, Linux, and Windows.
  • Guides users through the device-code authentication flow.
  • Assists in troubleshooting PATH configuration and environment-related errors.
  • Offers strategies for bypassing sandbox restrictions that block CLI operations.
  • Ensures secure handling of API keys by directing users to secret-management facilities.

When to use it

  • When you need to install or update the Boltz API CLI on your local machine.
  • When the CLI reports authentication errors or requires a fresh login.
  • When you encounter issues with the CLI not being found in your system PATH.
  • When sandbox environments prevent the CLI from opening a browser for OAuth login.
  • When you need to verify if your current CLI version is compatible with the API.

Advantages

  • Promotes secure practices by requiring explicit confirmation for remote script execution.
  • Centralizes troubleshooting for common CLI setup and authentication blockers.
  • Respects environment-specific configurations like update opt-outs.
  • Provides clear, platform-specific commands for consistent setup.

Usage examples

“How do I install the Boltz API CLI?”
The agent will provide the appropriate installation command for your OS and request your explicit confirmation before proceeding.
“My Boltz CLI is giving me an authentication error.”
The agent will check your current auth status and initiate the device-code login process to restore access.
“The CLI command is not found in my terminal.”
The agent will help you verify the installation and guide you through adding the binary to your system PATH.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/openai/boltz-cli-setup/download

  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip boltz-cli-setup.zip -d .agents/skills

Documentation by Boltz

Boltz CLI Setup

Use this skill for boltz-api installation, version, PATH, and authentication issues. The workflow skills assume boltz-api is already installed.

Verify Installation

Check that the CLI is available:

boltz-api --version

If boltz-api is missing or too old, prefer a version-pinned release artifact whose checksum or signature can be verified. If Boltz does not publish one for the user's platform, its official installer is the fallback.

Before downloading or running either installer, show the exact platform command and obtain the user's explicit confirmation. Explain that the command downloads mutable remote code, executes it as the user outside the sandbox, and therefore trusts install.boltz.bio at execution time. A general request to use or install Boltz is not confirmation for this specific risk.

macOS and Linux:

curl -fsSL https://install.boltz.bio/boltz-api/install.sh | sh

Windows PowerShell:

irm https://install.boltz.bio/boltz-api/install.ps1 | iex

The installer updates an existing boltz-api on PATH. If no binary is found, it installs to a user-local bin directory. Add the installed binary to PATH if boltz-api --version is still not found after install.

The sandbox can block browser login, OAuth callbacks, temp files, credential storage, and user-wide install paths. Request the host sandbox bypass/escalation needed for installation only after the installer confirmation above. The host approval must cover the exact command; do not treat an ordinary setup request as authorization to execute mutable remote code outside the sandbox.

Read references/sandbox.md when an agent sandbox blocks the installer, browser auto-open, OAuth callback, credential storage, temp files, or global install path.

Authenticate

Check the current auth state with:

boltz-api auth status

If auth status reports unauthenticated, or any Boltz command fails because authentication is missing or expired, start device-code login on the user's behalf before retrying:

boltz-api auth login --device-code

Do not ask the user for permission before starting device-code login; relaying the login URL/code and waiting for the CLI to complete is part of auth recovery. When sharing the authentication login URL/code, tell the user to use exactly boltz-api auth login --device-code.

For auth recovery, assume the CLI can auto-open the browser and run the exact command above. In sandboxed environments, request the host sandbox bypass/escalation needed for browser auto-open, OAuth callbacks, credential storage, or temp files.

For automation, an API key is still supported when it is already provisioned in the environment:

test -n "${BOLTZ_API_KEY:+configured}" && echo "BOLTZ_API_KEY is configured"

Never ask the user to paste an API key into chat or a command, and never print, log, or persist it in shell history or generated files. If the variable is not already provisioned, direct the user to their host's secret-management facility.

Version Checks

Do not hard-code expected commands or minimum versions in this skill. Treat the CLI's own update check as the source of truth.

When boltz-api reports that an update is available or required, relay that message and the install command it provides. The CLI may get this from a Boltz-hosted version metadata endpoint such as /cli/version, returning latest version, minimum supported version, whether an update is required, and platform-appropriate install instructions.

If a user asks why the CLI thinks it is stale, explain the split:

  • GitHub Releases define which CLI binaries are available to install.

  • The Boltz version endpoint defines API compatibility, including the minimum supported CLI version.

Respect user or CI opt-outs such as BOLTZ_API_NO_UPDATE_CHECK=1; do not force update checks when the environment disables them.

Files

Requirements and compatibility

Written for: OpenAI Codex

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs network access, Needs an API key

Security

What our scanner noticed· Medium risk

  • Phrasing that asks for actions without confirmation
  • Instructions that use the network
  • Downloads piped into a shell

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
Boltz
Publisher
OpenAI (Official)
Distributed by
OpenAI
Source
openai/plugins · plugins/boltz-api-cli/skills/boltz-cli-setup · commit d420d13
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from plugins/boltz-api-cli/LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Boltz or OpenAI.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download boltz-cli-setup.zip