@ludeo/cli 1.4.10 → 1.4.11

package/README.md

@@ -158,50 +158,6 @@ ludeo auth logout
 - **Cross-Platform**: Works on Windows, macOS, and Linux
 - **Automatic Updates**: Keep your CLI up to date with npm
 
-## Testing
-
-The CLI includes comprehensive unit tests that verify core functionality including authentication, build uploads, and request payload validation.
-
-### Running Tests
-
-```bash
-# Run all tests
-go test ./...
-
-# Run tests for a specific package
-go test ./pkg/commands -v
-go test ./internal/api -v
-
-# Run a specific test
-go test ./pkg/commands -v -run TestAuthSetToken
-go test ./pkg/commands -v -run TestBuildUploadMinor
-go test ./pkg/commands -v -run TestBuildUploadMajor
-
-# Run tests with coverage
-go test ./pkg/commands -cover
-go test ./... -coverprofile=coverage.out
-
-# View coverage report
-go tool cover -html=coverage.out
-```
-
-### Test Coverage
-
-The test suite includes:
-
-- **Authentication Tests**: Verify `set-token` command saves tokens correctly
-- **Build Upload Tests**: Verify minor and major build uploads send correct payloads
-- **Request Validation**: Verify HTTP requests include correct headers and JSON structure
-- **Bug Prevention**: Tests verify that `majorBuildId` is correctly included/excluded based on build type
-
-### Key Tests
-
-- `TestAuthSetToken` - Tests token saving functionality
-- `TestBuildUploadMinor` - Verifies minor builds include `majorBuildId` in request
-- `TestBuildUploadMajor` - Verifies major builds exclude `majorBuildId` from request
-- `TestBuildUploadRequestPayload` - Validates exact JSON payload structure
-- `TestBuildUploadRequestHeaders` - Verifies HTTP headers are correct
-
 ## Updating
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ludeo/cli",
-  "version": "1.4.10",
+  "version": "1.4.11",
   "description": "Ludeo CLI - Upload game builds and manage content on the Ludeo platform",
   "main": "index.js",
   "bin": {
@@ -26,7 +26,6 @@
   ],
   "author": "Ludeo Team",
   "license": "MIT",
-  "readme": "README.npm.md",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ludeo/cli.git"
@@ -38,8 +37,7 @@
     "bin/",
     "dist/",
     "scripts/",
-    "LICENSE",
-    "README.npm.md"
+    "LICENSE"
   ],
   "os": [
     "win32",

package/scripts/build-readme.js

@@ -3,9 +3,8 @@
  * Build README variants from docs/README.template.md.
  *
  * Outputs:
- *   README.md                          — GitHub repo (includes Testing)
- *   README.npm.md                      — npm package page (no Testing, no standalone exe refs)
- *   windows-releases/template/README.md — Windows ZIP release (exe install, file info)
+ *   README.md                          — GitHub repo + npm package page
+ *   windows-releases/template/README.md — Windows ZIP release (exe install)
  *
  * Conditional markers in the template:
  *   <!-- #if VARIANT -->   Include block only for that variant
@@ -13,7 +12,7 @@
  *   <!-- #else -->         Opposite of preceding #if
  *   <!-- #endif -->        End conditional block
  *
- * Supported variant names: repo, npm, windows
+ * Supported variant names: windows (used in #if conditionals)
  * Template variable: {{VERSION}} (replaced from package.json)
  *
  * Run: node scripts/build-readme.js
@@ -26,9 +25,8 @@ const ROOT = path.resolve(__dirname, '..');
 const TEMPLATE = path.join(ROOT, 'docs', 'README.template.md');
 
 const VARIANTS = {
-  repo: { flags: { repo: true, npm: false, windows: false } },
-  npm: { flags: { repo: false, npm: true, windows: false } },
-  windows: { flags: { repo: false, npm: false, windows: true } },
+  main: { flags: { windows: false } },
+  windows: { flags: { windows: true } },
 };
 
 function processTemplate(template, flags, vars) {
@@ -93,10 +91,8 @@ function main() {
     const content = processTemplate(template, config.flags, vars);
 
     let outputPath;
-    if (name === 'repo') {
+    if (name === 'main') {
       outputPath = path.join(ROOT, 'README.md');
-    } else if (name === 'npm') {
-      outputPath = path.join(ROOT, 'README.npm.md');
     } else if (name === 'windows') {
       const dir = path.join(ROOT, 'windows-releases', 'template');
       fs.mkdirSync(dir, { recursive: true });
@@ -106,7 +102,7 @@ function main() {
     fs.writeFileSync(outputPath, content, 'utf8');
   }
 
-  console.log('Built README.md (repo), README.npm.md (npm), windows-releases/template/README.md (windows)');
+  console.log('Built README.md and windows-releases/template/README.md');
 }
 
 main();

package/README.npm.md

@@ -1,227 +0,0 @@
-# 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
-
-### Getting Your Game ID and Access Token
-Both your **Game ID** and **Access Token** are available in the [Studio Labs](https://studio.ludeo.com) under **Environments**.
-
-- **Access Token:** In Environments, click **Create Token**, name it, then copy and save the token (you won't be able to see it again).
-- **Game ID:** In Environments, it's shown at the top of the page next to the API key.
-
-> **Windows note:** All commands below work in Command Prompt, PowerShell, and terminal emulators. For multi-line commands, replace `\` with `^` in Command Prompt.
-
-### 1. Authentication
-Save your access token:
-```bash
-ludeo auth set-token --access-token YOUR_ACCESS_TOKEN
-```
-
-You can also check if a token is saved:
-```bash
-ludeo auth status
-```
-
-### 2. Upload Your Build
-
-#### Interactive Mode (Recommended for First-Time Users)
-Simply run the upload command without flags to start the interactive wizard:
-```bash
-ludeo builds upload
-```
-
-The interactive mode will guide you through:
-1. **Game ID** - Enter your game's unique identifier
-2. **Build Creation Type** - Choose between `new` or `sdkFree`
-3. **Build Type** - Select `major` or `minor` (with warning for major builds)
-4. **Major Version Selection** - If creating a minor build, select from existing major versions
-5. **Game Version** - Enter the version number (e.g., 1.2.3)
-6. **SDK Version** - Enter the Ludeo SDK version (not required for sdkFree)
-7. **Executable Path** - Path to your game executable relative to build directory
-8. **Local Directory** - Path to your build files
-9. **Changes Description** - Optional description of what changed
-
-Before uploading, you'll see a summary of all options and the equivalent CLI command for future use in scripts or CI/CD pipelines.
-
-To disable interactive mode (for CI/CD or scripts):
-```bash
-ludeo builds upload --no-interactive [flags...]
-```
-
-#### Command-Line Mode
-Upload your game build with a simple command. The CLI supports two build creation types (**modification builds are not supported from the CLI—use [Studio Labs](https://studio.ludeo.com) for those**):
-
-#### New Build (Complete build from scratch) - DEFAULT
-```bash
-# With explicit build-creation-type
-ludeo builds upload \
-  --game-id YOUR_GAME_ID \
-  --exec-path game.exe \
-  --local-directory ./builds \
-  --build-creation-type new \
-  --build-type major \
-  --game-version "1.2.3" \
-  --sdk-version "2.0.0" \
-  --changes-description "Bug fixes and performance improvements"
-
-# Or simply omit --build-creation-type (defaults to "new")
-ludeo builds upload \
-  --game-id YOUR_GAME_ID \
-  --exec-path game.exe \
-  --local-directory ./builds \
-  --build-type major \
-  --game-version "1.2.3" \
-  --sdk-version "2.0.0"
-```
-
-#### SDK Free Build (Performance testing without Ludeo SDK)
-```bash
-ludeo builds upload \
-  --game-id YOUR_GAME_ID \
-  --exec-path game.exe \
-  --local-directory ./builds \
-  --build-creation-type sdkFree \
-  --build-type major \
-  --game-version "1.2.3" \
-  --changes-description "Performance testing build"
-```
-
-### 3. Build Types and Requirements
-
-**Build Creation Types (CLI):**
-- `new`: Complete build from scratch (requires game-version, sdk-version, build-type) **[DEFAULT]**
-- `sdkFree`: Performance testing without Ludeo SDK (requires game-version, build-type; sdk-version not required)
-
-**Note:** Modification builds (builds based on an existing build) are **not supported from the CLI**. Create modification builds from [Studio Labs](https://studio.ludeo.com) only.
-
-**Build Types:**
-- `major`: Major version build
-- `minor`: Minor version build (requires major-build-id)
-
-**Additional Flags:**
-- `--request-id`: Optional request ID for tracking
-- `--no-interactive`: Disable interactive prompts (for CI/CD or scripts)
-- `--dry-run`: Preview the upload without making any changes
-
-#### Dry-Run Mode
-Preview what would be uploaded without making any changes:
-```bash
-ludeo builds upload --dry-run \
-  --game-id YOUR_GAME_ID \
-  --exec-path game.exe \
-  --local-directory ./builds \
-  --build-type major \
-  --game-version "1.2.3" \
-  --sdk-version "2.0.0"
-```
-
-Dry-run will:
-- Validate all parameters and directory structure
-- Scan and display all files that would be uploaded
-- Show total file count and size
-- NOT create any build metadata or upload files
-
-### 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
-
-# Check if token is saved
-ludeo auth status
-
-# Remove saved token when done
-ludeo auth logout
-```
-
-## Features
-
-- **Interactive Mode**: Guided wizard for easy build uploads - just run `ludeo builds upload` and follow the prompts
-- **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
-- **Dry-Run Mode**: Preview uploads without making changes using `--dry-run`
-- **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 set-token --access-token ${{ secrets.LUDEO_ACCESS_TOKEN }}
-    ludeo builds upload \
-      --game-id ${{ env.GAME_ID }} \
-      --exec-path game.exe \
-      --local-directory ./builds \
-      --build-creation-type new \
-      --build-type major \
-      --game-version ${{ env.GAME_VERSION }} \
-      --sdk-version ${{ env.SDK_VERSION }}
-```
-
-## Troubleshooting
-
-### Installation Issues
-
-**Binary not found error:**
-```bash
-npm rebuild @ludeo/cli
-```
-
-**Permission issues (macOS/Linux):**
-```bash
-sudo npm install -g @ludeo/cli
-```
-
-**Windows (npm):**
-- Run PowerShell as Administrator
-- Ensure Node.js is properly installed
-
-### Common Issues
-
-**Authentication errors:**
-- Verify your access token is valid
-- Check if token is saved with `ludeo auth status`
-- Make sure you've saved your token with `ludeo auth set-token`
-
-**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