README
¶
Cubbit Composer CLI
The official CLI for managing your Cubbit DS3 Composer infrastructure. Built with Go, it provides a comprehensive and automation-friendly interface to control your entire DS3 environment — from swarms and tenants to gateways and user accounts.
Features
- Swarm Management — Create, configure, and manage distributed swarms
- Tenant Operations — Full tenant lifecycle management and configuration
- Infrastructure Control — Deploy Nexus, Redundancy Classes, nodes, and agents
- User & Account Management — Handle tenant accounts and user administration
- Gateway Configuration — Set up and manage S3-compatible gateway operations
- IAM — Fine-grained operator and policy management
- Interactive Workflows — Guided, step-by-step processes for complex tasks
- Automation-friendly — JSON/YAML/CSV output, quiet and silent modes
Installation
Pre-built Binaries (Recommended)
Download the latest release for your platform from the releases page, then:
# Linux / macOS
chmod +x cubbit
sudo mv cubbit /usr/local/bin/
# Verify
cubbit --version
Go Install
go install github.com/cubbit/composer-cli@latest
Make sure $GOPATH/bin is in your system PATH.
For more installation options (build from source, Bazel), see the Installation Guide.
Quick Start
# 1. Initialize configuration
cubbit config init
# 2. Log in
cubbit auth login --profile <profile_name>
# 3. Verify setup
cubbit config view
# 4. Explore available commands
cubbit --help
cubbit docs tree
For a full walkthrough, see the Getting Started Guide.
Documentation
| Guide | Description |
|---|---|
| Installation | All installation options: binaries, Go install, source, Bazel |
| Getting Started | First login, config setup, and your first commands |
| Configuration | Profiles, endpoints, output formats, config file reference |
| Swarms & Infrastructure | Swarms, Nexus, nodes, agents, and redundancy classes |
| Tenants, Users & Gateways | Tenant lifecycle, projects, user management, and S3 gateway setup |
| IAM | Operators, policies, and access control |
Platform Support
| Platform | Supported |
|---|---|
| Linux (amd64, arm64, armv6, armv7, 386) | ✅ |
| macOS (amd64, arm64) | ✅ |
| Windows (amd64, 386) | ✅ |
Contributing
Contributions are welcome! Please read CONTRIBUTING.md for development setup, code style guidelines, and the pull request process.
When reporting a bug, please include the CLI version (cubbit --version), your OS, the full error output, and steps to reproduce. Open an issue →
License
This project is licensed under the MIT License. See LICENSE for details.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
constants/constants.go
|
constants/constants.go |
|
src
|
|
|
action
Package action provides CLI actions for managing tenant accounts.
|
Package action provides CLI actions for managing tenant accounts. |
|
api
Package api provides functions to interact with the account API.
|
Package api provides functions to interact with the account API. |
|
cmd
Package cmd provides CLI commands for managing agents.
|
Package cmd provides CLI commands for managing agents. |
|
configuration
Package configuration provides configuration management for the CLI.
|
Package configuration provides configuration management for the CLI. |