Installation
Install OnglX Deploy CLI on your system
Cross-platform
Package Manager
System Requirements
Operating System
macOS, Linux, or Windows
AWS CLI
Version 2.0 or later
Internet Connection
For deployment and updates
Installation Methods
macOS (Homebrew)
Install using Homebrew package manager (recommended for macOS):
Terminal - OnglX Deploy
# Add the OnglX tap$ brew tap onglx/deploy# Install OnglX Deploy CLI$ brew install onglx-deploy# Verify installation$ onglx-deploy --versiononglx-deploy version 1.0.0
Linux (Package Manager)
Install using npm (works on all Linux distributions):
Terminal - OnglX Deploy
# Install globally using npm$ npm install -g @onglx/deploy-cli# Verify installation$ onglx-deploy --versiononglx-deploy version 1.0.0
Alternative: Direct Download
Terminal - OnglX Deploy
# Download and install binary directly$ curl -L https://github.com/onglx/deploy-cli/releases/latest/download/onglx-deploy-linux-amd64 -o onglx-deploy$ chmod +x onglx-deploy$ sudo mv onglx-deploy /usr/local/bin/
Windows
Install using npm or direct download:
Option 1: npm (PowerShell)
Terminal - OnglX Deploy
# Install globally using npmPS> npm install -g @onglx/deploy-cli# Verify installationPS> onglx-deploy --versiononglx-deploy version 1.0.0
Option 2: Direct Download
Terminal - OnglX Deploy
# Download Windows binaryPS> Invoke-WebRequest -Uri "https://github.com/onglx/deploy-cli/releases/latest/download/onglx-deploy-windows-amd64.exe" -OutFile "onglx-deploy.exe"# Add to PATH (optional)PS> Move-Item onglx-deploy.exe $env:USERPROFILE\bin\
Verify Installation
Once installed, verify OnglX Deploy is working correctly:
Terminal - OnglX Deploy
$ onglx-deploy --versiononglx-deploy version 1.0.0$ onglx-deploy --helpOnglX Deploy - Deploy AI inference APIs to your cloudUsage:onglx-deploy [command]Available Commands:init Initialize a new deploymentadd Add components to deploymentplan Show deployment plandeploy Deploy infrastructurestatus Show deployment statuslogs View deployment logsdestroy Destroy deploymentUse "onglx-deploy [command] --help" for more information about a command.
Configure AWS CLI
OnglX Deploy requires AWS CLI to be configured with valid credentials:
Install AWS CLI v2
macOS
$ brew install awscli
Linux
Terminal - OnglX Deploy
$ curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"$ unzip awscliv2.zip$ sudo ./aws/install
Configure AWS Credentials
Configure your AWS credentials and default region:
Terminal - OnglX Deploy
$ aws configureAWS Access Key ID [None]: YOUR_ACCESS_KEYAWS Secret Access Key [None]: YOUR_SECRET_KEYDefault region name [None]: us-east-1Default output format [None]: json# Test configuration$ aws sts get-caller-identity{"UserId": "AIDACKCEVSQ6C2EXAMPLE","Account": "123456789012","Arn": "arn:aws:iam::123456789012:user/your-username"}
Enable AWS Bedrock
Enable model access in AWS Bedrock console:
Required: Request Model Access
- 1. Go to AWS Bedrock console
- 2. Navigate to "Model access" in the left sidebar
- 3. Click "Manage model access"
- 4. Enable access for Claude 3 models (or your preferred models)
- 5. Submit the request (may take a few minutes to approve)
Test Your Setup
Test that everything is configured correctly:
Terminal - OnglX Deploy
# Test AWS access$ aws sts get-caller-identity# Test Bedrock model access$ aws bedrock list-foundation-models --region us-east-1# Test OnglX Deploy$ onglx-deploy --version
Updating OnglX Deploy
Homebrew (macOS)
Terminal - OnglX Deploy
$ brew update$ brew upgrade onglx-deploy
npm (All platforms)
$ npm update -g @onglx/deploy-cli
✅ Installation Complete!
OnglX Deploy CLI is now installed and configured. You're ready to deploy AI infrastructure!
Next step: Follow the Quick Start guide
Need help?: Check the troubleshooting guide