@turboops/cli 1.0.0-dev.580 → 1.0.0-dev.583

package/README.md

@@ -1,6 +1,6 @@
 # TurboCLI
 
-Command line interface for TurboOps deployments.
+Command line interface for TurboOps.
 
 ## Installation
 
@@ -17,7 +17,7 @@ npx @turboops/cli
 ### Authentication
 
 ```bash
-# Login interactively
+# Login interactively (opens browser)
 turbo login
 
 # Login with token (for CI/CD)
@@ -37,100 +37,115 @@ turbo logout
 turbo init
 
 # Show current configuration
-turbo config
-```
+turbo config show
 
-### Deployment
+# Set configuration value
+turbo config set project <slug>
 
-```bash
-# Deploy to an environment
-turbo deploy production
-turbo deploy staging
-turbo deploy dev
+# Get configuration value
+turbo config get project
 
-# Deploy specific image
-turbo deploy production --image v1.2.3
+# Clear configuration
+turbo config clear --all
+turbo config clear --token
+turbo config clear --project
+```
 
-# Deploy without waiting
-turbo deploy production --no-wait
+### Status
 
-# Rollback to previous deployment
-turbo rollback production
+```bash
+# Show status of all environments
+turbo status
 
-# Rollback to specific deployment
-turbo rollback production --to <deployment-id>
+# Show status of specific environment
+turbo status production
 ```
 
-### Container Management
+### Logs
 
 ```bash
-# Restart containers
-turbo restart production
+# View logs
+turbo logs production
 
-# Stop containers
-turbo stop production
+# Follow logs (stream)
+turbo logs production --follow
 
-# Start stopped containers
-turbo wake production
+# Limit lines
+turbo logs production --lines 50
 
-# Show status
-turbo status
-turbo status production
+# Filter by service
+turbo logs production --service api
 ```
 
-### Environment Variables
+### Deployment (CI/CD)
 
-```bash
-# List environment variables
-turbo env production
+The deploy command is designed for CI/CD pipelines using Project Tokens.
 
-# Show secret values
-turbo env production --reveal
+```bash
+# Trigger deployment and wait for completion (default)
+turbo deploy production
 
-# Set variable
-turbo env production set API_KEY=secret123
+# Deploy specific image tag
+turbo deploy production --image my-app:v1.2.3
 
-# Set as secret
-turbo env production set API_KEY=secret123 --secret
+# Deploy without waiting (fire-and-forget)
+turbo deploy staging --no-wait
 
-# Remove variable
-turbo env production unset API_KEY
+# Custom timeout (default: 10 minutes)
+turbo deploy production --timeout 900000
 ```
 
-### Logs
+**Options:**
+
+| Option | Description |
+|--------|-------------|
+| `-i, --image <tag>` | Docker image tag to deploy |
+| `-w, --wait` | Wait for deployment to complete (default) |
+| `--no-wait` | Do not wait for deployment to complete |
+| `--timeout <ms>` | Timeout in milliseconds when waiting (default: 600000) |
+
+**Note:** This command requires a Project Token with `deploy` permission. Set the token via `TURBOOPS_TOKEN` environment variable or `--token` flag.
+
+### Pipeline Management
+
+Generate and manage CI/CD pipeline configurations.
 
 ```bash
-# View logs
-turbo logs production
+# Generate pipeline interactively
+turbo pipeline generate
 
-# Follow logs (stream)
-turbo logs production --follow
+# Generate GitLab CI pipeline
+turbo pipeline generate --type gitlab
 
-# Limit lines
-turbo logs production --lines 50
-```
+# Generate GitHub Actions pipeline
+turbo pipeline generate --type github
 
-## CI/CD Usage
+# Force overwrite existing pipeline
+turbo pipeline generate --type gitlab --force
 
-### GitLab CI
+# Custom output path
+turbo pipeline generate --type gitlab --output ./ci/pipeline.yml
 
-```yaml
-deploy:
-  stage: deploy
-  script:
-    - npx @turboops/cli deploy production --wait
-  environment:
-    name: production
+# Show required secrets
+turbo pipeline secrets
+
+# Show secrets for specific pipeline type
+turbo pipeline secrets --type github
 ```
 
-### GitHub Actions
+**Options for `pipeline generate`:**
+
+| Option | Description |
+|--------|-------------|
+| `-t, --type <type>` | Pipeline type: `gitlab` or `github` |
+| `-f, --force` | Overwrite existing pipeline file |
+| `-o, --output <path>` | Custom output path |
 
-```yaml
-- name: Deploy
-  run: npx @turboops/cli deploy production --wait
-  env:
-    TURBOOPS_TOKEN: ${{ secrets.TURBOOPS_TOKEN }}
-    TURBOOPS_PROJECT: ${{ vars.TURBOOPS_PROJECT }}
+### Self-Update
+
+```bash
+# Check for updates and show upgrade instructions
+turbo self-update
 ```
 
 ## Environment Variables
@@ -146,7 +161,6 @@ deploy:
 ```bash
 --project <slug>      Override project slug
 --token <token>       Override API token
---api <url>           Override API URL
 --json                Output as JSON
 --quiet               Only show errors
 --verbose             Show debug output
@@ -160,7 +174,11 @@ deploy:
 | 0 | Success |
 | 1 | General error |
 | 2 | Timeout |
-| 3 | Health check failed |
+| 3 | Network error |
+| 10 | Authentication error |
+| 11 | Not found |
+| 12 | API error |
+| 20 | Validation error |
 
 ## License