Skip to main content

​
Overview

The SuperBox CLI is a Python (Click) tool for managing MCP servers from initialization to deployment. Commands map directly to the backend implementation in superbox.ai/src/superbox/cli.
All CLI documentation matches the actual backend implementation. For detailed setup and usage, visit https://superbox.mintlify.app

​
Installation

# Clone backend repository
git clone https://github.com/areebahmeddd/superbox.ai.git
cd superbox.ai

# Create virtual environment
python -m venv .venv
source .venv/bin/activate  # macOS/Linux
# or .\.venv\Scripts\Activate.ps1 (Windows)

# Install CLI
python -m pip install -e .[cli]

​
Quick Start

1

Authenticate

superbox auth login --provider google
# or
superbox auth login --provider email
Device flow for Google/GitHub is supported; email/password works too.
2

Init server config

superbox init
Creates superbox.json with name, repo URL, entrypoint, license, etc.
3

Publish with scans

superbox push --name my-mcp
Runs SonarCloud, Bandit, GitGuardian, tool discovery, then uploads to S3 registry.
4

Configure client

superbox pull --name my-mcp --client cursor
Clients supported: vscode, cursor, windsurf, claude, chatgpt.
5

Run & view logs

superbox run --name my-mcp
superbox logs --name my-mcp --follow

​
Available Commands

​
Authentication

auth register

Create new account

auth login

Log in with email/Google/GitHub

auth status

Check auth status

auth logout

Log out

​
Server Management

init

Initialize superbox.json

push

Publish to registry with security scans

pull

Configure client for server

search

List registry servers

​
Testing & Debugging

run

Interactive terminal session

test

Test without registry

logs

View CloudWatch logs

inspect

Open repository in browser

​
Command Reference

# Authentication
superbox auth register
superbox auth login [--provider email|google|github]
superbox auth status
superbox auth refresh
superbox auth logout

# Server management
superbox init
superbox push [--name NAME] [--force]
superbox pull --name NAME --client CLIENT
superbox search
superbox inspect --name NAME

# Testing & debugging
superbox run --name NAME
superbox test --url URL --client CLIENT
superbox logs --name NAME [--follow]

​
Configuration

The CLI expects a .env file in your working directory for AWS/Firebase config: 
# AWS (required for S3 registry)
AWS_REGION=ap-south-1
AWS_ACCESS_KEY_ID=your_key
AWS_SECRET_ACCESS_KEY=your_secret
S3_BUCKET_NAME=your-bucket

# Lambda executor
LAMBDA_BASE_URL=https://your-api.example.com/run

# Scanners (for push command)
SONAR_TOKEN=your_token
SONAR_ORGANIZATION=your_org
GITGUARDIAN_API_KEY=your_key

​
Token Storage

Authentication tokens are stored in ~/.superbox/auth.json: 
{
  "id_token": "...",
  "refresh_token": "...",
  "email": "user@example.com",
  "provider": "google"
}

​
Examples

# Register and login
superbox auth register
superbox auth login --provider google

# Initialize and publish
superbox init
superbox push --name weather-mcp

# Configure client
superbox pull --name weather-mcp --client cursor

# Test and monitor
superbox run --name weather-mcp
superbox logs --name weather-mcp --follow

​
Next Steps

Installation

Setup guide

Authentication

Auth commands

Publishing

Publish servers

Backend Setup

Run local server
For complete documentation, visit https://superbox.mintlify.app