toolkit

README

Blaxel Toolkit

A powerful CLI and Go SDK for building, deploying, and managing AI agents on the Blaxel platform.

What is Blaxel?

Blaxel is a platform for deploying production-ready AI agents, MCP servers, sandboxes, and jobs. The Blaxel Toolkit provides everything you need to interact with the Blaxel platform from your command line or Go applications.

Installation

macOS (Homebrew)

brew tap blaxel-ai/blaxel
brew install blaxel

Other Platforms

Download the latest release from GitHub Releases or see docs.blaxel.ai for detailed installation instructions.

Quick Start

# Login to your workspace
bl login my-workspace

# Create a new agent
bl new agent my-agent

# Deploy your agent
bl deploy

# Connect to a sandbox
bl connect sandbox my-sandbox

# Chat with your agent
bl chat my-agent

Key Features

• 🤖 Agent Management: Create, deploy, and chat with AI agents
• 🔌 MCP Servers: Build Model Context Protocol servers for tool integration
• 📦 Sandboxes: Interactive shell environments for remote execution
• ⚙️ Jobs: Schedule and run background tasks
• 🚀 Deployment: Interactive deployment with real-time logs
• 📊 Resource Management: Get, delete, and manage all your Blaxel resources
• 🔐 Authentication: Multiple auth methods (API key, device flow, client credentials)

Core Commands

Command	Description
bl login	Authenticate with Blaxel workspace
bl new	Create agents, MCP servers, sandboxes, or jobs
bl deploy	Deploy your projects to Blaxel
bl get	List resources (agents, sandboxes, models, etc.)
bl connect sandbox	Interactive shell for sandbox environments
bl chat	Chat with deployed agents
bl run	Execute jobs or agents
bl serve	Run projects locally

Run bl --help or bl <command> --help for detailed usage.

Documentation

• 📖 Full CLI Reference
• 🔧 Command Examples
• 🚀 Getting Started Guide
• 📦 Sample Configurations

Repository Structure

.
├── cli/          # CLI command implementations
├── docs/         # Auto-generated command documentation
├── samples/      # Example configurations
└── test/         # Integration tests

Development

See CONTRIBUTING.md for development setup and guidelines.

# Build the CLI
make build

# Run tests
make test

# Update SDK dependency
go get -u github.com/blaxel-ai/sdk-go@latest

Go SDK

The toolkit uses the Blaxel Go SDK for programmatic access to Blaxel APIs:

import (
    blaxel "github.com/blaxel-ai/sdk-go"
    "github.com/blaxel-ai/sdk-go/option"
)

// Create a client with API key
client := blaxel.NewClient(option.WithAPIKey("your-api-key"))

// Or use environment-based authentication
client, _ := blaxel.NewDefaultClient()

// Use the SDK
agents, _ := client.Agents.List(ctx)

License

See LICENSE for details.