CLI Reference - Actual Command Guide
Early Development Status
This CLI is in early development. Only basic commands are implemented. Many documented features are planned for future releases.
Complete CLI Feature Documentation
This page documents ALL actual CLI features found in the codebase. Many of these advanced features were previously undocumented.
Available Commands
OnglX Deploy currently implements these basic commands:
Limited Implementation
Only basic project deployment commands are implemented. Advanced project management, multi-cloud features, and cost optimization are not yet available.
Implemented Commands
Basic Project Commands
Creates deploy.yml configuration file in current directory.
1# Initialize with AWS (default)
2onglx-deploy init --host aws
3
4# Initialize with GCP (beta)
5onglx-deploy init --host gcp
6
7# Initialize for multi-cloud (defaults to AWS)
8onglx-deploy init --host multiOptions:
- --host HOST- Cloud provider (aws, gcp, multi) - REQUIRED
Basic Workflow:
- onglx-deploy init --host aws- Initialize project
- onglx-deploy add inference --component api --type openai- Add components
- onglx-deploy plan- Review deployment plan
- onglx-deploy deploy- Deploy resources
Adds AI inference API or UI components to deployment configuration.
# Add OpenAI-compatible API
onglx-deploy add inference --component api --type openai --model anthropic.claude-3-5-sonnet
# Add OpenWebUI interface
onglx-deploy add inference --component ui --type openwebui --size smallOptions:
- --component- Component type (api or ui) - REQUIRED
- --type- Implementation type (openai or openwebui) - REQUIRED
- --model- Model name for API components
- --size- Instance size for UI components (small, medium, large)
- --region- Override region for this component
Performs a dry-run using Terraform to show what resources would be created.
# Show what would be deployed
onglx-deploy planShows:
- Resources to be created/modified/destroyed
- Terraform execution plan
- No actual changes made
Apply the deployment configuration using Terraform to create cloud resources.
# Deploy with confirmation prompt
onglx-deploy deploy
# Deploy without prompts
onglx-deploy deploy --auto-approveOptions:
- --auto-approve- Skip interactive approval
- --max-parallel- Maximum parallel operations (default: 4)
Display current status of deployed resources and health checks.
# Show deployment status
onglx-deploy status
# Verbose status information
onglx-deploy status --verboseShows:
- Component health status
- Last deployment information
- Active endpoints
Display logs from Lambda functions and other deployed components.
1# View recent logs (last 100 lines)
2onglx-deploy logs
3
4# Follow logs in real-time
5onglx-deploy logs --follow --tail 50
6
7# Show logs from specific time
8onglx-deploy logs --since 1h
9
10# Filter by component
11onglx-deploy logs apiOptions:
- --tail- Number of lines to show (default: 100)
- --follow, -f- Follow log output in real-time
- --since- Show logs since duration (e.g., 1h, 30m)
Remove all resources created by deployment. This action cannot be undone.
# Destroy with confirmation
onglx-deploy destroy
# Destroy without prompts
onglx-deploy destroy --auto-approveOptions:
- --auto-approve- Skip interactive approval
Warning: This permanently deletes all cloud resources!
What's Not Implemented Yet
Commands Not Yet Implemented
Many advanced features are planned but not implemented. These commands will return errors if used.
Project Management Commands (Not Implemented):
- projects list/create/remove/info
- get projects/staging
- describe project/inference
- remove inference/database
- commit(staging workflow)
Multi-Cloud Commands (Not Implemented):
- cloud compare/deploy/recommend/status/optimize
- All multi-cloud functionality
Advanced Features (Not Implemented):
- costand cost analysis
- doctor(diagnostics)
- auth(authentication)
- examples/tutorial/tier/domains
- validate/clean/fixutilities
Basic Example Workflow
1# 1. Initialize project
2onglx-deploy init --host aws
3
4# 2. Add inference API component
5onglx-deploy add inference --component api --type openai
6
7# 3. Review deployment plan
8onglx-deploy plan
9
10# 4. Deploy to AWS
11onglx-deploy deploy
12
13# 5. Check status
14onglx-deploy status
15
16# 6. View logs
17onglx-deploy logs --followEarly Development
This CLI is in early development with basic deployment functionality. Many documented features are planned for future releases.