sealos-cli 0.1.0 → 1.1.0

package/README.md

@@ -1,6 +1,6 @@
 # Sealos CLI
 
-Official CLI tool for Sealos Cloud - Manage devbox, applications, databases, and object storage
+Official CLI tool for Sealos Cloud - Manage auth, workspaces, devboxes, databases, and templates.
 
 ## Project Structure
 
@@ -18,21 +18,13 @@ src/
 │   │   └── index.ts
 │   ├── devbox/               # Devbox management
 │   │   └── index.ts
-│   ├── s3/                   # S3 object storage
-│   │   └── index.ts
 │   ├── database/             # Database management
 │   │   └── index.ts
 │   ├── template/             # Template management
 │   │   └── index.ts
-│   ├── quota/                # Resource quotas
-│   │   └── index.ts
-│   ├── app/                  # Application management
-│   │   └── index.ts
-│   └── config/               # CLI configuration
-│       └── index.ts
 ├── lib/                       # Shared libraries
-│   ├── api.ts                # API client
-│   ├── config.ts             # Configuration management
+│   ├── api-client.ts         # OpenAPI client factories
+│   ├── auth.ts               # Sealos auth and kubeconfig headers
 │   ├── errors.ts             # Error handling
 │   └── output.ts             # Output formatting
 ├── types/                     # TypeScript type definitions
@@ -42,22 +34,22 @@ src/
 
 ## Architecture
 
-### Configuration Management (`lib/config.ts`)
+### Authentication (`lib/auth.ts`)
 
-- Manages CLI configuration at `~/.sealos/config.json`
-- Handles multiple contexts (hosts/workspaces)
-- Supports environment variables (e.g., `KUBECONFIG`)
+- Manages Sealos auth state at `~/.sealos/auth.json`
+- Stores current workspace kubeconfig at `~/.sealos/kubeconfig`
+- Builds provider API headers with URL-encoded kubeconfig content
 
-### API Client (`lib/api.ts`)
+### OpenAPI Clients (`lib/api-client.ts`)
 
-- Axios-based HTTP client with interceptors
-- Automatic token injection from current context
-- Unified error handling
-- Support for KUBECONFIG environment variable
+- Type-safe clients generated from `src/docs/*_openapi.json`
+- Routes template calls to `template.<region>/api/v2alpha`
+- Routes database calls to `dbprovider.<region>/api/v2alpha`
+- Routes devbox calls to `devbox.<region>/api/v2alpha`
 
 ### Output Formatting (`lib/output.ts`)
 
-- Support for multiple formats: JSON, YAML, Table
+- JSON and table output helpers for command responses
 - Colored terminal output using chalk
 - Loading spinners using ora
 - Table formatting using table
@@ -104,118 +96,128 @@ npm test
 ### Authentication
 
 ```bash
-# Login in browser and exchange for kubeconfig automatically
-sealos login hzh.sealos.run
-
-# Login with kubeconfig content
-sealos login hzh.sealos.run --token "$(cat ~/.kube/config)"
+# Login in browser and exchange for regional token + kubeconfig automatically
+sealos-cli login https://usw-1.sealos.io
 
 # Check current user
-sealos whoami
+sealos-cli whoami
+
+# Inspect auth and switch workspace
+sealos-cli auth info
+sealos-cli auth list
+sealos-cli auth switch <workspace-id-or-team-name>
 
 # Logout
-sealos logout
+sealos-cli logout
 ```
 
 ### Template Management
 
 ```bash
 # Deploy from the catalog
-sealos template deploy perplexica --name my-app --set OPENAI_API_KEY=xxx
+sealos-cli template deploy perplexica --name my-app --set OPENAI_API_KEY=xxx
 
 # Validate raw template YAML without creating resources
-sealos template deploy --file ./template.yaml --dry-run
+sealos-cli template deploy --file ./template.yaml --dry-run
 ```
 
 ### Workspace Management
 
 ```bash
 # List workspaces
-sealos workspace list
+sealos-cli workspace list
 
 # Switch workspace
-sealos workspace switch production
+sealos-cli workspace switch production
 
 # Show current workspace
-sealos workspace current
+sealos-cli workspace current
 ```
 
 ### Devbox Management
 
 ```bash
 # Create a devbox
-sealos devbox create --name my-devbox --template nextjs --cpu 2c --memory 4g
+sealos-cli devbox create --name my-devbox --runtime next.js --cpu 2c --memory 4g --port 3000:http:public
 
 # List devboxes
-sealos devbox list
-sealos devbox list --output json
+sealos-cli devbox list
+sealos-cli devbox list --output json
 
 # Get devbox details
-sealos devbox get my-devbox
+sealos-cli devbox get my-devbox
+
+# Update resources or ports
+sealos-cli devbox update my-devbox --cpu 4 --memory 8 --port portName=web,number=3000,protocol=http,isPublic=true
 
-# Connect to devbox
-sealos devbox connect my-devbox --ide cursor
+# Start/Pause/Shutdown/Restart
+sealos-cli devbox start my-devbox
+sealos-cli devbox pause my-devbox
+sealos-cli devbox shutdown my-devbox
+sealos-cli devbox restart my-devbox
 
-# Start/Stop/Restart
-sealos devbox start my-devbox
-sealos devbox stop my-devbox
-sealos devbox restart my-devbox
+# Configure autostart and inspect monitor data
+sealos-cli devbox autostart my-devbox --exec-command "npm start"
+sealos-cli devbox monitor my-devbox --step 2m
+
+# Templates, releases, and deployments
+sealos-cli devbox templates
+sealos-cli devbox releases list my-devbox
+sealos-cli devbox releases create my-devbox --tag v1-0-0 --description "First release"
+sealos-cli devbox releases deploy my-devbox v1-0-0
+sealos-cli devbox deployments my-devbox
 
 # Delete devbox
-sealos devbox delete my-devbox --force
+sealos-cli devbox delete my-devbox
 ```
 
+Implementation: `src/commands/devbox/index.ts`, backed by `src/docs/devbox_openapi.json`.
+
 ### Database Management
 
 ```bash
 # List databases
-sealos database list
+sealos-cli database list
 
 # Get database details
-sealos database get my-db
+sealos-cli database get my-db
 
 # Create a database
-sealos database create postgresql --name my-db --cpu 1 --memory 2 --storage 5 --replicas 1
+sealos-cli database create postgresql --name my-db --cpu 1 --memory 2 --storage 5 --replicas 1
 
 # Show connection details
-sealos database connection my-db
+sealos-cli database connection my-db
 
 # More commands
-sealos database --help
-sealos database <subcommand> --help
+sealos-cli database --help
+sealos-cli database <subcommand> --help
+
+# Operational commands backed by src/docs/database_openapi.json
+sealos-cli database update my-db --cpu 2 --memory 4
+sealos-cli database start my-db
+sealos-cli database pause my-db
+sealos-cli database restart my-db
+sealos-cli database backup my-db --name manual-backup
+sealos-cli database backups my-db
+sealos-cli database restore my-db --from manual-backup --name restored-db
+sealos-cli database enable-public my-db
+sealos-cli database disable-public my-db
+sealos-cli database log-files <pod-name> --db-type postgresql --log-type runtimeLog
+sealos-cli database logs <pod-name> --db-type postgresql --log-type runtimeLog --log-path /path/to/log
 ```
 
 Implementation: `src/commands/database/index.ts`
 
-### Configuration
-
-```bash
-# List all config
-sealos config list
-
-# Get config value
-sealos config get currentContext
-
-# Set config value
-sealos config set key value
-```
-
 ## Environment Variables
 
-- `KUBECONFIG`: Path to Kubernetes config file (automatically included in API requests)
+- `SEALOS_REGION`: Default Sealos region URL for auth and public provider endpoints
+- `SEALOS_DATABASE_HOST`: Override database provider host for database commands
+- `SEALOS_DEVBOX_HOST`: Override devbox provider host for devbox commands
 - `DEBUG`: Enable debug mode for verbose error output
 
-## TODO
-
-Most command implementations contain TODO comments indicating where API integration is needed. Key areas:
+## v1 Scope
 
-1. **Authentication**: OAuth flow for browser-based login
-2. **API Integration**: Connect all commands to actual Sealos API endpoints
-3. **S3 Operations**: File upload/download with progress tracking
-4. **Devbox Management**: Connect devbox commands to actual Sealos API endpoints
-5. **Interactive Prompts**: Use inquirer for confirmations
-6. **YAML Support**: Add YAML output formatting
-7. **Config Nesting**: Support nested config key access
+The v1 command surface is limited to auth, workspace, template, database, and devbox operations. Future modules such as S3/object storage, quota inspection, and application management are intentionally not registered or documented as available commands.
 
 ## Best Practices Implemented
 
@@ -223,9 +225,8 @@ Most command implementations contain TODO comments indicating where API integrat
 - TypeScript for type safety
 - Shared utilities for common operations
 - Consistent error handling
-- Multiple output formats
+- JSON and table output formats
 - Environment variable support
-- Configuration file management
 - Loading indicators for async operations
 - Color-coded terminal output