CLI Commands

Complete reference for OnglX Deploy CLI

Command Reference

Examples

OnglX Deploy provides a comprehensive CLI for deploying AI inference APIs and web interfaces to AWS Bedrock. Each command is designed to be intuitive and follows common CLI patterns.

Terminal - OnglX Deploy

$ onglx-deploy --help
OnglX Deploy - Deploy AI inference APIs to your cloud
Usage:
  onglx-deploy [command]
Available Commands:
  init        Initialize a new deployment
  add         Add components to deployment
  plan        Show deployment plan
  deploy      Deploy infrastructure
  status      Show deployment status
  logs        View deployment logs
  destroy     Destroy deployment
Use "onglx-deploy [command] --help" for more information.

init

Initialize a new deployment

Create a new OnglX Deploy project with AWS configuration and generate the deployment configuration file.

Terminal - OnglX Deploy

$ onglx-deploy init --host aws --region us-east-1
✓ Initialized deployment: my-project
✓ Config: deploy.yml

View full documentation →

add

Add components to deployment

Add API and UI components to your deployment configuration with automatic validation.

Terminal - OnglX Deploy

$ onglx-deploy add api
✓ Added api component with OpenAI compatibility
$ onglx-deploy add ui  
✓ Added ui component with OpenWebUI

View full documentation →

plan

Show deployment plan

Preview changes and estimated costs before deployment. Shows detailed resource changes.

Terminal - OnglX Deploy

$ onglx-deploy plan
Resources to be created:
  + AWS Lambda Function
  + API Gateway
  
Estimated cost: $5.25/month

View full documentation →

deploy

Deploy infrastructure

Deploy your AI infrastructure to AWS with automatic rollback on failure and signal handling.

Terminal - OnglX Deploy

$ onglx-deploy deploy
✓ Creating Lambda function
✓ Setting up API Gateway
✓ Deployment completed!

View full documentation →

status

Show deployment status

Check the health and status of your deployed components with detailed endpoint information.

Terminal - OnglX Deploy

$ onglx-deploy status
Components:
  [✓] api/openai: Healthy
  [✓] ui/openwebui: Healthy

View full documentation →

logs

View deployment logs

Stream logs from your deployed components for debugging and monitoring.

Terminal - OnglX Deploy

$ onglx-deploy logs --follow
[api] 2024-01-01T12:00:00Z INFO Request received
[ui]  2024-01-01T12:00:01Z INFO User logged in

View full documentation →

destroy

Destroy deployment

Safely remove all deployed resources with confirmation prompts and cleanup verification.

Terminal - OnglX Deploy

$ onglx-deploy destroy
⚠️  This will destroy all resources.
Do you really want to destroy? Type 'yes': yes
✓ Infrastructure destroyed successfully

View full documentation →

🚀 Quick Workflow

The typical OnglX Deploy workflow follows these steps:

Initialize

onglx-deploy init

Add Components

onglx-deploy add

Plan & Deploy

onglx-deploy plan/deploy

Monitor

onglx-deploy status/logs

Try the Quick Start Tutorial →