@SanthPrasad/nugget-backend-cli

🚀 CLI tool for Nugget AI Backend Server - Configure and manage your backend URL

A cross-platform CLI tool that allows you to configure, start, and manage your Nugget AI Backend Server from anywhere.

⚠️ License Required

This CLI requires a valid access token to function.

📦 Installation

npm install -g @SanthPrasad/nugget-backend-cli

🔐 Activation

Step 1: Request a License

nugget license --request

This will generate a Machine ID and Request Token.

Step 2: Activate Your License

Once you receive your access token:

nugget activate

Enter your access token when prompted.

Step 3: Start Using

nugget init

🚀 Quick Start

# Check license status
nugget license --status

# Initialize configuration
nugget init

# Set backend URL
nugget url --set https://your-backend.com:3011

# Test connection
nugget url --test

# Start local server
nugget start

📖 Commands

License Commands (No activation required)

| Command | Description | |---------|-------------| | nugget activate | Activate with access token | | nugget license --request | Request a new license | | nugget license --status | Check license status | | nugget info | Show package info |

Main Commands (Requires activation)

| Command | Description | |---------|-------------| | nugget init | Interactive setup wizard | | nugget config | View/edit configuration | | nugget url --set <url> | Set backend URL | | nugget url --test | Test connection | | nugget start | Start local server | | nugget stop | Stop server | | nugget status | Check server status | | nugget logs | View server logs |

🔧 Configuration

nugget init

Interactive setup wizard to configure all settings.

nugget config

# List all configuration
nugget config --list

# Set a value
nugget config --set backendUrl=https://example.com:3011

# Get a specific value
nugget config --get backendUrl

# Reset all configuration
nugget config --reset

nugget url

# Set backend URL
nugget url --set https://your-server.com:3011

# Test connection
nugget url --test

nugget start

# Start on default port
nugget start

# Start on specific port
nugget start --port 4000

# Start in background
nugget start --detach

💻 Programmatic Usage

const { createClient } = require('@SanthPrasad/nugget-backend-cli');

const client = createClient({
  backendUrl: 'https://your-server.com:3011',
  port: 3011
});

// Test connection
const isConnected = await client.testConnection();

// Get server health
const health = await client.getHealth();

// Start local server
await client.startServer(3011);

🌐 Supported Platforms

• ✅ Windows (PowerShell, CMD)
• ✅ macOS (Terminal, iTerm)
• ✅ Linux (Bash, Zsh)
• ✅ WSL

📝 License

See LICENSE.md - Requires valid access token.