BitBuilder Cloud CLI is an all-in-one tool for provisioning and managing multi-tenant infrastructure on bare metal servers running VyOS v1.5 or Proxmox. Similar to fly.io's flyctl, bbctl provides a seamless experience for deploying, scaling, and managing your applications across distributed infrastructure.
- Manage VMs - Create, configure, and manage virtual machines across your infrastructure
- Storage Management - Provision and attach volumes to your applications
- Network Configuration - Set up and manage virtual networks with secure connectivity
- Multi-provider Support - Works with VyOS v1.5 and Proxmox
- Interactive TUI - Terminal-based dashboard for visual resource management
- Bare Metal Efficiency - Optimized for bare metal server deployment
- E2E Encryption - Secure networking with WireGuard integration (coming soon)
cargo install bbctlDownload the latest release for your platform from the releases page.
git clone https://github.com/bitbuilder-io/bbctl.git
cd bbctl
cargo build --release# Initialize a new BitBuilder Cloud project
bbctl init
# Deploy an application
bbctl deploy
# List running instances
bbctl instances list
# Create a new volume
bbctl volumes create my-volume --size 10
# Manage networks
bbctl networks create my-network --cidr 192.168.0.0/24Run bbctl without commands to enter the interactive Terminal UI mode:
bbctlThe TUI provides a visual dashboard to manage your infrastructure with keyboard navigation.
| Key | Action |
|---|---|
1-5 |
Switch tabs |
Tab / Shift+Tab |
Next/Previous tab |
j/k or ↑/↓ |
Navigate items |
a |
Add new item |
d |
Delete selected |
e |
Edit selected |
r |
Refresh data |
q or ESC |
Quit |
? |
Show help |
View More Screenshots
Manage virtual machines across all providers with real-time status updates.
Provision and manage storage volumes with attachment information.
Configure virtual networks and manage instance connectivity.
Quick reference for all keyboard shortcuts.
# List all instances
bbctl instances list
# Create a new instance
bbctl instances create web-1 --provider vyos --region nyc --cpu 2 --memory 4 --disk 80
# Start/Stop/Delete instances
bbctl instances start i-01234567
bbctl instances stop i-01234567
bbctl instances delete i-01234567# List volumes
bbctl volumes list
# Create and attach volumes
bbctl volumes create db-data --size 100 --region nyc
bbctl volumes attach vol-01234567 --instance i-01234567
bbctl volumes detach vol-01234567# List networks
bbctl networks list
# Create network and connect instances
bbctl networks create app-network --cidr 192.168.1.0/24
bbctl networks connect net-01234567 --instance i-01234567bbctl is designed with a layered architecture:
┌────────────────────────────────────────────────────────────────────┐
│ User Interface Layer │
│ ┌─────────────────────┐ ┌─────────────────────┐ │
│ │ CLI Commands │ │ Terminal UI │ │
│ └─────────────────────┘ └─────────────────────┘ │
├────────────────────────────────────────────────────────────────────┤
│ Service Layer │
│ ┌─────────────────────┐ ┌─────────────────────┐ │
│ │ Provider Services │ │ Resource Services │ │
│ └─────────────────────┘ └─────────────────────┘ │
├────────────────────────────────────────────────────────────────────┤
│ API Layer │
│ ┌─────────────────────┐ ┌─────────────────────┐ │
│ │ VyOS API │ │ Proxmox API │ │
│ └─────────────────────┘ └─────────────────────┘ │
└────────────────────────────────────────────────────────────────────┘
| Provider | Status | Features |
|---|---|---|
| VyOS v1.5 | Supported | SSH, HTTP API, WireGuard |
| Proxmox | Supported | REST API, VM/Container management |
Configuration files are stored in ~/.bbctl/:
settings.toml- Global settingsproviders.toml- Provider configurationscredentials.toml- Authentication credentials
default_provider = "vyos-router"
default_region = "nyc"
telemetry_enabled = false
log_level = "info"bbctl supports advanced networking features:
- L3VPN with EVPN - BGP-based control plane for multi-tenant isolation
- VXLAN Overlay - Scalable tenant traffic encapsulation
- WireGuard - Secure encrypted management plane
- VRF Isolation - Complete tenant network separation
For detailed network architecture, see VyOS Network Plan.
- Rust 1.70+
- Cargo
# Development build
cargo build
# Release build
cargo build --release
# Run tests
cargo test
# Format code
cargo fmt
# Lint
cargo clippybbctl/
├── src/
│ ├── api/ # VyOS and Proxmox API clients
│ ├── models/ # Data models (Instance, Volume, Network)
│ ├── services/ # Business logic
│ ├── config/ # Configuration management
│ ├── app.rs # Application state
│ ├── ui.rs # TUI components
│ ├── tui.rs # Terminal setup
│ └── main.rs # Entry point
├── tests/ # Test suite
├── docs/ # Documentation
└── vyos-lab/ # VyOS test environment
A containerized VyOS test environment is provided for development:
# Setup the VyOS test lab
cd tests/vyos-lab
./setup-lab.sh
# Test bbctl against the lab
bbctl test-vyos --host localhost --port 21022 --username vyos --api-key bbctl-test-api
# Cleanup
./cleanup-lab.shSee VyOS Test Lab Setup for detailed instructions.
- User Guide - Complete guide for using bbctl
- Command Reference - Detailed command documentation
- Configuration Guide - Configuration options
- Architecture Design - Technical architecture
- API Documentation - API schema and OpenAPI docs
- Rust Integration - Rust/TypeScript compatibility
- VyOS Network Plan - Network architecture design
- VyOS Test Lab Setup - Test environment guide
View the documentation index for a complete list.
- Phase 1: Base infrastructure and API clients
- Phase 2: Complete resource management
- Phase 3: Enhanced TUI with real-time updates
- Phase 4: Multi-tenancy and RBAC
- Phase 5: CI/CD integration and public cloud support
See PLAN.md for detailed implementation plans.
Contributions are welcome! Please follow the development guidelines in the Architecture Design document.
# Clone the repository
git clone https://github.com/bitbuilder-io/bbctl.git
# Create a feature branch
git checkout -b feature/my-feature
# Make changes and test
cargo test
# Submit a pull requestMIT License.
- VyOS - Open source network operating system
- Proxmox VE - Virtualization management platform
- Ratatui - Rust TUI library