CLI Reference — Aquilia Documentation
Comprehensive guide and documentation for CLI Reference in the Aquilia framework. View API reference, examples, and implementation patterns.
CLI Command Reference Detailed documentation for aq provider and aq deploy CLI commands The aq command-line tool provides interactive terminal flows for managing cloud logins, updating remote service variables, and deploying projects. All commands leverage structured terminal output, featuring status indicators, execution phases, and diagnostic warnings. Provider Authentication Commands Authentication is the gatekeeper for all provider integrations. Use the following commands to check, establish, or purge workspace credentials: aq provider login render Authenticates with the Render API using a personal API bearer key. The key is validated by listing account owners and is then encrypted via RenderCredentialStore . Argument: PROVIDER_NAME (must be render) Options: --token, -t: API bearer token. If omitted, prompts securely. If -, reads from standard input. --region, -r: Default deployment region (e.g. frankfurt, oregon). Default is oregon. aq provider status render Checks the state of your local credentials, runs decryption tests, queries connection speed to Render, and displays owner email metadata. aq provider logout render Erases stored credentials. To prevent recovery of secret key remnants on SSD controllers, the command overwrites the local credentials.surp file with random bytes before deletion. Render Operational Commands The aq provider render subcommands allow direct management of Render services, deployments, and logs: 1. aq provider render services Lists all services provisioned inside the active Render workspace owner account. Displays name, region, status, and type. 2. aq provider render deploys Lists deployment histories for a target service. Required Option: --service, -s SERVICE_NAME 3. aq provider render deploy-trigger Triggers a new manual deployment for the target service on Render. Required Option: --service, -s SERVICE_NAME 4. aq provider render deploy-cancel Cancels an active, ongoing build or deployment on Render. Required Argument: DEPLOY_ID (e.g. dep-xxxx) Required Option: --service, -s SERVICE_NAME 5. aq provider render deploy-rollback Rolls back a service to a previous deployment. Triggered automatically on failure during aq deploy render runs. Required Argument: DEPLOY_ID Required Option: --service, -s SERVICE_NAME 6. aq provider render logs Retrieves recent application logs. Output is formatted with color-coded severity levels (INFO, WARN, ERROR). Required Option: --service, -s SERVICE_NAME Options: --limit, -l: Number of log lines to show (default: 50). --level: Filter severity: info | warn | error. Environment Variable Management Use the aq provider render env subcommand group to synchronize container environment variables: List Variables Set/Update Variable Delete Variable Deployment Commands Once authenticated, run aq deploy render to trigger the deployment run. The CLI supports multiple options to customize and query services directly: 1. aq deploy render (Standard Deployment) Compiles, validates, builds, pushes, and provisions the workspace. It prints progress updates for each step. Options: --image, -i: Docker image path (e.g. docker.io/user/repo:tag). --region, -r: Deployment datacenter (oregon | frankfurt | ohio | virginia | singapore). --plan: Compute tier size (free | starter | standard | pro | pro_plus). --num-instances: Explicit container scaling factor. --service-name: Custom service name override on Render. --registry-credential-id: Private registry credential ID (if pulling from a private registry). --force, -f: Overwrite configuration without prompt checks. 2. aq deploy render --dry-run (Dry Run Planning) Synthesizes the configuration properties, compiles the local OCI configuration, resolves dependency mappings, and prints the target payload structure without writing any files or contacting Render endpoints. 3. aq deploy render --status (Query Live Status) Connects to the Render API and prints the active status (e.g. creating, live, or suspended), public URL, deployment history logs, and healthy instance count. 4. aq deploy render --destroy (Teardown Service) Tears down and destroys the deployed Render web service and associated configuration. To prevent accidental production data loss, this command requires interactive confirmation unless --yes is supplied. Next Chapters 01 Providers Overview Deployment strategy, container building pipelines, and configuration approaches. 02 Render PaaS Integration Deployment pipeline workflow details, API clients, and service configuration payloads. ) } function ArrowRightIcon() { return ( )
Go to Homepage