@ludeo/cli 1.1.0 → 1.1.2

package/README.md

@@ -1,355 +1,125 @@
 # Ludeo CLI
 
-A comprehensive command-line tool for studios to upload game builds and manage content on the Ludeo platform with complete file upload capabilities.
+The official Ludeo CLI tool for uploading game builds to the Ludeo platform. Install via npm for easy setup and automatic updates.
 
-## 🚀 Features
+## Installation
 
-- **Complete Build Uploads**: Upload both build metadata and all build files in one command
-- **Multipart File Uploads**: Automatically handles large files (>100MB) using multipart uploads
-- **Concurrent Uploads**: Uploads multiple files simultaneously with 32 workers for maximum performance
-- **Upload Recovery**: Automatic retry logic with exponential backoff and state persistence
-- **Progress Tracking**: Real-time progress updates during file uploads with worker statistics
-- **Dynamic Service Selection**: Automatically chooses between local and API services
-- **Secure Authentication**: Access token-based authentication with automatic validation
-- **Environment Support**: Staging, production, and development environment support
-- **Session Management**: Automatic token validation and session refresh
-
-## 🏗️ Architecture
-
-The CLI uses a dynamic service architecture that automatically adapts based on your authentication status:
-
-- **Authenticated Mode**: Full API service with complete file uploads via cloud-builds
-- **Local Mode**: Metadata-only service for development and testing
-- **Automatic Fallback**: Seamlessly switches between services as needed
-
-## 📦 Installation
-
-### Build from Source
 ```bash
-git clone <repository>
-cd ludeo-cli
-make build
-```
-
-### Install Locally
-```bash
-make install
+npm install -g @ludeo/cli
 ```
 
-## 🚀 Quick Start
-
-### Option 1: NPM Installation (Recommended for most users)
+Verify the installation:
 ```bash
-# Install globally
-npm install -g @ludeo/cli
-
-# Verify installation
 ludeo --version
-
-# Authenticate
-ludeo auth login --access-token YOUR_ACCESS_TOKEN
 ```
 
-### Option 2: Build from Source
-#### 1. Build the CLI
-```bash
-make build
-```
+## Quick Start
 
-#### 2. Authenticate
+### 1. Authentication
+Get your access token from the Ludeo platform and authenticate:
 ```bash
-./build/ludeo auth login --access-token YOUR_ACCESS_TOKEN
+ludeo auth login --access-token YOUR_ACCESS_TOKEN
 ```
 
-### 3. Upload a Complete Build
+### 2. Upload Your Build
+Upload your game build with a simple command:
 ```bash
-./build/ludeo builds upload \
+ludeo builds upload \
   --game-id YOUR_GAME_ID \
   --exec-path ./builds/game.exe \
   --local-directory ./builds
 ```
 
-## 📚 Usage
-
-### Authentication Commands
+### 3. Optional Parameters
+Add version information and descriptions:
 ```bash
-# Login with access token
-ludeo auth login --access-token <token>
-
-# Check authentication status
-ludeo auth status
-
-# Validate current access token
-ludeo auth validate
-
-# Logout and clear credentials
-ludeo auth logout
+ludeo builds upload \
+  --game-id YOUR_GAME_ID \
+  --exec-path ./builds/game.exe \
+  --local-directory ./builds \
+  --game-version "1.2.3" \
+  --changes-description "Bug fixes and performance improvements"
 ```
 
-### Builds Commands
+### 4. Manage Builds
 ```bash
-# Upload a complete build (metadata + files)
-ludeo builds upload [flags]
-
-# List builds for a game version
-ludeo builds list --game-id <id>
+# List your builds
+ludeo builds list --game-id YOUR_GAME_ID
 
 # Get build details
-ludeo builds get --game-id <id> --build-id <id>
+ludeo builds get --game-id YOUR_GAME_ID --build-id BUILD_ID
 ```
 
-### Upload Required Flags
-- `--game-id`: Game ID (required)
-- `--exec-path`: Path to the executable relative to local directory (required)
-- `--local-directory`: Local directory containing all build files (required)
-
-### Upload Optional Flags
-- `--game-version`: Game version (e.g., 1.2.3)
-- `--sdk-version`: SDK version (e.g., 2.0.0)
-- `--runtime-environment`: Runtime environment (e.g., windows, linux)
-- `--changes-description`: Description of changes in this build
-- `--base-build-id`: Base build ID for modification builds
-- `--major-build-id`: Major build ID for minor builds
-- `--request-id`: Request ID for tracking
-
-## 🔐 Authentication Flow
-
-The CLI implements a secure authentication flow that validates access tokens before any upload operation:
-
-1. **Token Storage**: Access tokens are stored securely in `~/.ludeo/config.json`
-2. **Pre-upload Validation**: Every upload operation automatically validates the token first
-3. **API Endpoint**: Calls `{{baseUrl}}/authentication/cli` with Authorization header
-4. **Session Management**: Receives session token from authentication endpoint
-5. **Secure Uploads**: All subsequent uploads use the session token as Bearer token
-
-### Security Features
-- **Automatic Validation**: Tokens are validated before every API operation
-- **Session Persistence**: Valid sessions are maintained for the duration of the token
-- **Secure Storage**: Tokens are stored in user's home directory with appropriate permissions
-- **No Token Logging**: Only first/last 4 characters of tokens are displayed in logs
+## Features
 
-## 🔧 How It Works
+- **Easy Upload**: Upload complete game builds with a single command
+- **Large File Support**: Automatically handles large files and multiple files
+- **Progress Tracking**: Real-time progress updates during uploads
+- **Cross-Platform**: Works on Windows, macOS, and Linux
+- **Automatic Updates**: Keep your CLI up to date with npm
 
-### Complete Upload Process
-The CLI performs a complete upload in the following steps:
-
-1. **Validation**: Validates the local directory and build parameters
-2. **Base Path Derivation**: Automatically derives `basePath` from the root folder name of `--local-directory`
-   - Example: `--local-directory ./builds` → `basePath = "builds"`
-   - Example: `--local-directory ./game-assets` → `basePath = "game-assets"`
-3. **Build Creation**: Creates build metadata via the sonic-server API with the derived `basePath`
-4. **File Upload**: Uploads all files to S3 via the cloud-builds service
-   - Small files (<100MB): Direct upload
-   - Large files (≥100MB): Multipart upload with concurrent parts
-5. **File Registration**: Registers uploaded files with the cloud-builds service
-6. **Completion**: Marks the upload as complete
-
-### Dynamic Service Selection
-The CLI automatically chooses the appropriate service based on your authentication status:
-
-- **With Access Token**: Uses complete API service with file uploads
-- **Without Token**: Falls back to local service (metadata only)
-
-### Base Path Derivation
-The CLI automatically derives the `basePath` from your `--local-directory`:
+## Updating
 
 ```bash
-# If you specify:
---local-directory ./builds
-
-# The CLI will derive:
-basePath = "builds"
-
-# And send to the API:
-{
-  "basePath": "builds",
-  "execPath": "./builds/game.exe",  # Your input unchanged
-  "localDirectory": "./builds"      # Your input unchanged
-}
+npm update -g @ludeo/cli
 ```
 
-This matches exactly how the UI works - the system derives the base path from the uploaded directory structure.
-
-### File Upload Features
-- **Automatic Multipart**: Files over 100MB automatically use multipart uploads
-- **Concurrent Processing**: Up to 32 files uploaded simultaneously for maximum performance
-- **Upload Recovery**: Automatic retry with exponential backoff and state persistence
-- **Progress Tracking**: Real-time progress updates with worker statistics
-- **Error Handling**: Graceful error handling without stopping other uploads
-- **Cross-Platform**: Handles Windows and Unix path separators
-
-### Performance
-- **High-Performance Concurrent Uploads**: 32 workers for maximum throughput
-- **Multipart Optimization**: Large files split into 100MB parts for optimal performance
-- **Connection Reuse**: HTTP connections reused for better performance
-- **Progress Reporting**: Real-time feedback with detailed worker statistics
-- **Upload State Persistence**: Recovery from interruptions in `~/.ludeo-upload-state/`
-
-## ⚙️ Configuration
-
-The CLI stores configuration in `~/.ludeo/config.json`. You can also use environment variables:
+## CI/CD Integration
 
-- `LUDEO_ACCESS_TOKEN`: Your Ludeo access token
-- `LUDEO_ENVIRONMENT`: Target environment (staging, production)
-- `LUDEO_API_BASE_URL`: Sonic-server API base URL
-- `LUDEO_CLOUD_BUILDS_URL`: Cloud-builds API base URL
+### GitHub Actions
+```yaml
+- name: Install Ludeo CLI
+  run: npm install -g @ludeo/cli
 
-### Environment Support
-
-The CLI supports three environments:
-
-#### Staging (Default)
-```json
-{
-  "environment": "staging",
-  "api_base_url": "https://services.stg.use1.ludeo.com/api/v3",
-  "cloud_builds_url": "https://services.stg.use1.ludeo.com/api/v3/cloud-builds"
-}
-```
-
-#### Production
-```json
-{
-  "environment": "production",
-  "api_base_url": "https://services.ludeo.com/api/v3",
-  "cloud_builds_url": "https://services.ludeo.com/api/v3/cloud-builds"
-}
-```
-
-#### Development (Internal Use Only)
-```json
-{
-  "environment": "development",
-  "api_base_url": "http://localhost:80/api/v3",
-  "cloud_builds_url": "http://localhost:80/api/v3/cloud-builds"
-}
-```
-
-### Environment Variables
-You can set the environment using environment variables:
-- `LUDEO_ENVIRONMENT`: Set to "development", "staging", or "production"
-
-## 📋 Examples
-
-### Basic Complete Upload
-```bash
-ludeo builds upload \
-  --game-id 123 \
-  --exec-path ./builds/game.exe \
-  --local-directory ./builds
-```
-
-### Upload with Optional Parameters
-```bash
-ludeo builds upload \
-  --game-id 123 \
-  --exec-path ./builds/game.exe \
-  --local-directory ./builds \
-  --game-version "1.2.3" \
-  --sdk-version "2.1.0" \
-  --changes-description "Bug fixes and performance improvements" \
-  --runtime-environment "windows"
+- name: Upload Build
+  run: |
+    ludeo auth login --access-token ${{ secrets.LUDEO_ACCESS_TOKEN }}
+    ludeo builds upload \
+      --game-id ${{ env.GAME_ID }} \
+      --exec-path ./builds/game.exe \
+      --local-directory ./builds
 ```
 
-### List Builds
-```bash
-ludeo builds list --game-id 123
-```
-
-### Get Build Details
-```bash
-ludeo builds get --game-id 123 --build-id 456
-```
+## Troubleshooting
 
-## 🛠️ Development
+### Installation Issues
 
-### Building
+**Binary not found error:**
 ```bash
-make build
+npm rebuild @ludeo/cli
 ```
 
-### Testing
+**Permission issues (macOS/Linux):**
 ```bash
-make test
+sudo npm install -g @ludeo/cli
 ```
 
-### Local Development
-```bash
-# For local development, use environment variables (recommended)
-export LUDEO_ENVIRONMENT=development
-./ludeo auth login --access-token YOUR_TOKEN
-
-# Note: --env flag is hidden from users and only available for internal development
-```
-
-### Go Development
-```bash
-go run main.go builds upload --help
-```
-
-## 🚨 Troubleshooting
+**Windows issues:**
+- Run PowerShell as Administrator
+- Ensure Node.js is properly installed
 
 ### Common Issues
 
-1. **Authentication Errors**
-   - Ensure access token is valid and not expired
-   - Check that the access token has upload permissions
-
-2. **File Upload Failures**
-   - Verify local directory exists and is readable
-   - Check network connectivity to S3 endpoints
-   - Ensure files are not corrupted or locked
-
-3. **Large File Issues**
-   - Multipart uploads require stable network connections
-   - Very large files (>1GB) may take significant time
-   - Monitor progress output for upload status
-   - Upload state is automatically saved for recovery
-
-4. **Path Issues**
-   - Use forward slashes (/) in paths for cross-platform compatibility
-   - Ensure executable path is relative to base path
-
-5. **Service Selection Issues**
-   - Check authentication status with `ludeo auth status`
-   - Verify access token is properly stored
-   - Check environment configuration
-
-### Debug Mode
-Enable debug output by setting the log level:
-```bash
-export LUDEO_LOG_LEVEL=debug
-ludeo builds upload [flags]
-```
-
-### Service Mode Debugging
-The CLI provides detailed logging about which service is being used:
-- **API Service**: Full functionality with file uploads and concurrent processing
-- **Local Service**: Metadata only, no file uploads
-
-### Concurrent Upload Debugging
-- **Upload State**: Check `~/.ludeo-upload-state/` for recovery files
-- **Worker Statistics**: Monitor progress output for active worker counts
-- **Retry Logic**: Failed uploads automatically retry with exponential backoff
+**Authentication errors:**
+- Verify your access token is valid
+- Check token permissions with `ludeo auth status`
 
-## 📖 API Reference
+**Upload failures:**
+- Ensure your build directory exists and is readable
+- Check your internet connection
+- Verify file paths are correct
 
-### Service Interfaces
-- **`builds.Service`**: Basic build operations (metadata only)
-- **`builds.CompleteUploadService`**: Complete upload operations including files
+**Large files:**
+- Large files may take time to upload
+- Ensure stable internet connection
 
-### Key Endpoints
-- **Authentication**: `{{baseUrl}}/authentication/cli`
-- **Builds**: `{{baseUrl}}/sonic-server/builds`
-- **Cloud Builds**: `{{cloudBuildsUrl}}/uploads`
+## Support
 
-## 🤝 Support
+Need help? Here's how to get support:
 
-For issues and questions:
-- Check the troubleshooting section above
-- Review the CLI output for error details
-- Contact the Ludeo platform team
+1. Check this README and troubleshooting section
+2. Run `npm rebuild @ludeo/cli` if you encounter issues
+3. Contact the Ludeo platform team for additional assistance
 
-## 📄 License
+For detailed documentation and advanced usage, visit the [Ludeo Developer Portal](https://developers.ludeo.com).
 
-This project is proprietary to Ludeo and its partners.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ludeo/cli",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Ludeo CLI - Upload game builds and manage content on the Ludeo platform",
   "main": "index.js",
   "bin": {
@@ -31,7 +31,6 @@
   "files": [
     "bin/",
     "dist/",
-    "README.md",
     "LICENSE"
   ],
   "os": [