@ludeo/cli 1.0.0 → 1.1.1

package/README.md

@@ -1,252 +1,125 @@
 # Ludeo CLI
 
-A command-line tool for studios to upload game builds and manage content on the Ludeo platform.
+The official Ludeo CLI tool for uploading game builds to the Ludeo platform. Install via npm for easy setup and automatic updates.
 
-## Features
-
-- **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 for faster processing
-- **Progress Tracking**: Real-time progress updates during file uploads
-- **Authentication**: Secure access token-based authentication
-- **Environment Support**: Staging and production environment support
-
-## Quick Start
+## Installation
 
-### Option 1: NPM Installation (Recommended for most users)
 ```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
 ```
 
-#### 2. Authenticate
+Verify the installation:
 ```bash
-./build/ludeo auth login --access-token YOUR_ACCESS_TOKEN
-```
-
-### 3. Upload a Complete Build
-```bash
-./build/ludeo builds upload \
-  --game-version-id YOUR_GAME_VERSION_ID \
-  --base-path ./builds \
-  --exec-path ./builds/game.exe \
-  --local-directory ./builds
+ludeo --version
 ```
 
-## Usage
-
-### Authentication Commands
-```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
-```
+## Quick Start
 
-### Builds Commands
+### 1. Authentication
+Get your access token from the Ludeo platform and authenticate:
 ```bash
-# Upload a complete build (metadata + files)
-ludeo builds upload [flags]
-
-# List builds for a game version
-ludeo builds list --game-version-id <id>
-
-# Get build details
-ludeo builds get --game-version-id <id> --build-id <id>
+ludeo auth login --access-token YOUR_ACCESS_TOKEN
 ```
 
-#### Upload Required Flags
-- `--game-version-id`: Game version ID
-- `--exec-path`: Path to the executable (full path)
-- `--local-directory`: Local directory containing all build files
-
-#### 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}}/v3/authentication/cli/:accessToken` to validate tokens
-4. **Session Management**: Creates/validates session for the token if it doesn't exist
-5. **Secure Uploads**: All subsequent uploads use the validated 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
-
-## Examples
-
-### Basic Complete Upload
+### 2. Upload Your Build
+Upload your game build with a simple command:
 ```bash
 ludeo builds upload \
-  --game-version-id 123 \
+  --game-id YOUR_GAME_ID \
   --exec-path ./builds/game.exe \
   --local-directory ./builds
 ```
 
-### Upload with Optional Parameters
+### 3. Optional Parameters
+Add version information and descriptions:
 ```bash
 ludeo builds upload \
-  --game-version-id 123 \
+  --game-id YOUR_GAME_ID \
   --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"
+  --changes-description "Bug fixes and performance improvements"
 ```
 
-### List Builds
+### 4. Manage Builds
 ```bash
-ludeo builds list --game-version-id 123
-```
+# List your builds
+ludeo builds list --game-id YOUR_GAME_ID
 
-## How It Works
+# Get build details
+ludeo builds get --game-id YOUR_GAME_ID --build-id BUILD_ID
+```
 
-### Complete Upload Process
-The CLI performs a complete upload in the following steps:
+## Features
 
-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
+- **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
 
-### 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 4 files uploaded simultaneously
-- **Progress Tracking**: Real-time progress updates for large uploads
-- **Error Handling**: Automatic retry and failure marking
-- **Cross-Platform**: Handles Windows and Unix path separators
-
-### Performance
-- **Concurrent Uploads**: Multiple files uploaded simultaneously
-- **Multipart Optimization**: Large files split into 100MB parts for optimal performance
-- **Connection Reuse**: HTTP connections reused for better performance
-- **Progress Reporting**: Real-time feedback during long uploads
-
-## Configuration
-
-The CLI stores configuration in `~/.ludeo/config.json`. You can also use environment variables:
-
-- `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
-
-### Default Configuration
-```json
-{
-  "environment": "staging",
-  "api_base_url": "https://services.stg.use1.ludeo.com/api/v3/sonic-server",
-  "cloud_builds_url": "https://services.stg.use1.ludeo.com/api/v3/cloud-builds"
-}
-```
+## CI/CD Integration
 
-## Development
+### GitHub Actions
+```yaml
+- name: Install Ludeo CLI
+  run: npm install -g @ludeo/cli
 
-### Building
-```bash
-make build
+- 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
 ```
 
-### Testing
+## Troubleshooting
+
+### Installation Issues
+
+**Binary not found error:**
 ```bash
-make test
+npm rebuild @ludeo/cli
 ```
 
-### Local Development
+**Permission issues (macOS/Linux):**
 ```bash
-go run main.go builds upload --help
+sudo npm install -g @ludeo/cli
 ```
 
-## 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
+**Authentication errors:**
+- Verify your access token is valid
+- Check token permissions with `ludeo auth status`
 
-2. **File Upload Failures**
-   - Verify local directory exists and is readable
-   - Check network connectivity to S3 endpoints
-   - Ensure files are not corrupted or locked
+**Upload failures:**
+- Ensure your build directory exists and is readable
+- Check your internet connection
+- Verify file paths are correct
 
-3. **Large File Issues**
-   - Multipart uploads require stable network connections
-   - Very large files (>1GB) may take significant time
-   - Monitor progress output for upload status
+**Large files:**
+- Large files may take time to upload
+- Ensure stable internet connection
 
-4. **Path Issues**
-   - Use forward slashes (/) in paths for cross-platform compatibility
-   - Ensure executable path is relative to base path
+## Support
 
-### Debug Mode
-Enable debug output by setting the log level:
-```bash
-export LUDEO_LOG_LEVEL=debug
-ludeo builds upload [flags]
-```
+Need help? Here's how to get support:
 
-## Support
+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
+
+For detailed documentation and advanced usage, visit the [Ludeo Developer Portal](https://developers.ludeo.com).
 
-For issues and questions:
-- Check the troubleshooting section above
-- Review the CLI output for error details
-- Contact the Ludeo platform team

package/README.md.backup

@@ -0,0 +1,125 @@
+# Ludeo CLI
+
+The official Ludeo CLI tool for uploading game builds to the Ludeo platform. Install via npm for easy setup and automatic updates.
+
+## Installation
+
+```bash
+npm install -g @ludeo/cli
+```
+
+Verify the installation:
+```bash
+ludeo --version
+```
+
+## Quick Start
+
+### 1. Authentication
+Get your access token from the Ludeo platform and authenticate:
+```bash
+ludeo auth login --access-token YOUR_ACCESS_TOKEN
+```
+
+### 2. Upload Your Build
+Upload your game build with a simple command:
+```bash
+ludeo builds upload \
+  --game-id YOUR_GAME_ID \
+  --exec-path ./builds/game.exe \
+  --local-directory ./builds
+```
+
+### 3. Optional Parameters
+Add version information and descriptions:
+```bash
+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"
+```
+
+### 4. Manage Builds
+```bash
+# List your builds
+ludeo builds list --game-id YOUR_GAME_ID
+
+# Get build details
+ludeo builds get --game-id YOUR_GAME_ID --build-id BUILD_ID
+```
+
+## Features
+
+- **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
+
+## Updating
+
+```bash
+npm update -g @ludeo/cli
+```
+
+## CI/CD Integration
+
+### GitHub Actions
+```yaml
+- name: Install Ludeo CLI
+  run: npm install -g @ludeo/cli
+
+- 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
+```
+
+## Troubleshooting
+
+### Installation Issues
+
+**Binary not found error:**
+```bash
+npm rebuild @ludeo/cli
+```
+
+**Permission issues (macOS/Linux):**
+```bash
+sudo npm install -g @ludeo/cli
+```
+
+**Windows issues:**
+- Run PowerShell as Administrator
+- Ensure Node.js is properly installed
+
+### Common Issues
+
+**Authentication errors:**
+- Verify your access token is valid
+- Check token permissions with `ludeo auth status`
+
+**Upload failures:**
+- Ensure your build directory exists and is readable
+- Check your internet connection
+- Verify file paths are correct
+
+**Large files:**
+- Large files may take time to upload
+- Ensure stable internet connection
+
+## Support
+
+Need help? Here's how to get support:
+
+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
+
+For detailed documentation and advanced usage, visit the [Ludeo Developer Portal](https://developers.ludeo.com).
+

package/dist/README.md

@@ -0,0 +1,125 @@
+# Ludeo CLI
+
+The official Ludeo CLI tool for uploading game builds to the Ludeo platform. Install via npm for easy setup and automatic updates.
+
+## Installation
+
+```bash
+npm install -g @ludeo/cli
+```
+
+Verify the installation:
+```bash
+ludeo --version
+```
+
+## Quick Start
+
+### 1. Authentication
+Get your access token from the Ludeo platform and authenticate:
+```bash
+ludeo auth login --access-token YOUR_ACCESS_TOKEN
+```
+
+### 2. Upload Your Build
+Upload your game build with a simple command:
+```bash
+ludeo builds upload \
+  --game-id YOUR_GAME_ID \
+  --exec-path ./builds/game.exe \
+  --local-directory ./builds
+```
+
+### 3. Optional Parameters
+Add version information and descriptions:
+```bash
+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"
+```
+
+### 4. Manage Builds
+```bash
+# List your builds
+ludeo builds list --game-id YOUR_GAME_ID
+
+# Get build details
+ludeo builds get --game-id YOUR_GAME_ID --build-id BUILD_ID
+```
+
+## Features
+
+- **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
+
+## Updating
+
+```bash
+npm update -g @ludeo/cli
+```
+
+## CI/CD Integration
+
+### GitHub Actions
+```yaml
+- name: Install Ludeo CLI
+  run: npm install -g @ludeo/cli
+
+- 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
+```
+
+## Troubleshooting
+
+### Installation Issues
+
+**Binary not found error:**
+```bash
+npm rebuild @ludeo/cli
+```
+
+**Permission issues (macOS/Linux):**
+```bash
+sudo npm install -g @ludeo/cli
+```
+
+**Windows issues:**
+- Run PowerShell as Administrator
+- Ensure Node.js is properly installed
+
+### Common Issues
+
+**Authentication errors:**
+- Verify your access token is valid
+- Check token permissions with `ludeo auth status`
+
+**Upload failures:**
+- Ensure your build directory exists and is readable
+- Check your internet connection
+- Verify file paths are correct
+
+**Large files:**
+- Large files may take time to upload
+- Ensure stable internet connection
+
+## Support
+
+Need help? Here's how to get support:
+
+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
+
+For detailed documentation and advanced usage, visit the [Ludeo Developer Portal](https://developers.ludeo.com).
+

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@ludeo/cli",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "Ludeo CLI - Upload game builds and manage content on the Ludeo platform",
   "main": "index.js",
   "bin": {
-    "ludeo": "./bin/ludeo.js"
+    "ludeo": "bin/ludeo.js"
   },
   "scripts": {
     "build": "make build-all",
@@ -23,7 +23,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/ludeo/cli.git"
+    "url": "git+https://github.com/ludeo/cli.git"
   },
   "engines": {
     "node": ">=16.0.0"
@@ -31,7 +31,6 @@
   "files": [
     "bin/",
     "dist/",
-    "README.md",
     "LICENSE"
   ],
   "os": [
@@ -44,4 +43,3 @@
     "arm64"
   ]
 }
-