CLICLI Installation

CLI Installation

The Syaala CLI provides a command-line interface for deploying and managing AI models on GPU infrastructure.

Production-Ready: All commands use real API endpoints. Ensure you have valid API credentials before proceeding.

Installation

npm install -g @syaala/cli

Verify Installation

syaala --version

Expected output:

0.1.0

Quick Start

Authenticate

syaala auth login --api-key your-api-key

Or use interactive mode:

syaala auth login --interactive

Check Status

syaala auth status

Deploy Your First Model

syaala deployments create \
  --name my-llm \
  --model meta-llama/Llama-2-7b-hf \
  --runtime vllm \
  --gpu-type NVIDIA_A100 \
  --gpu-count 1

Requirements

  • Node.js: v18.0.0 or higher
  • Operating System: macOS, Linux, Windows (WSL)
  • API Key: Generate from dashboard settings

Environment Variables

The CLI uses these environment variables for configuration:

# API Configuration
SYAALA_API_KEY=sk_live_...        # Your API key (required)
SYAALA_API_URL=https://api.syaala.com  # API base URL (optional)
SYAALA_ORG_ID=org_...             # Default organization ID (optional)
 
# CLI Configuration
SYAALA_DEBUG=true                 # Enable debug logging (optional)
SYAALA_TIMEOUT=30000              # Request timeout in ms (optional)

Set environment variables:

export SYAALA_API_KEY=sk_live_...

Configuration File

The CLI stores authentication profiles in:

  • macOS/Linux: ~/.config/syaala/config.json
  • Windows: %APPDATA%\syaala\config.json

Example configuration:

{
  "profiles": {
    "default": {
      "apiKey": "sk_live_...",
      "orgId": "org_...",
      "apiUrl": "https://api.syaala.com"
    },
    "staging": {
      "apiKey": "sk_test_...",
      "orgId": "org_...",
      "apiUrl": "http://localhost:3001/api"
    }
  },
  "activeProfile": "default"
}
⚠️

Security: The config file contains sensitive credentials. Ensure proper file permissions (0600 on Unix systems).

Updating

npm update -g @syaala/cli

Uninstalling

npm uninstall -g @syaala/cli

Troubleshooting

Permission Errors

If you encounter permission errors during installation:

# Use npx to run without global install
npx @syaala/cli --version
 
# Or install with --prefix flag
npm install -g --prefix ~/.local @syaala/cli
export PATH="$HOME/.local/bin:$PATH"

Authentication Failures

# Verify API key is set
echo $SYAALA_API_KEY
 
# Check authentication status
syaala auth status
 
# Re-authenticate
syaala auth logout
syaala auth login --api-key your-new-key

Connection Issues

# Test API connectivity
curl https://api.syaala.com/api/health
 
# Enable debug mode
SYAALA_DEBUG=true syaala deployments list

Next Steps

Syaala CLIIndex