Bitaic CLI
The Bitaic CLI lets DevOps, platform, operations, and automation teams install agents, inspect agent state, run manual monitoring checks, and retrieve selected monitoring data from a terminal or script.
What You Can Do
The Bitaic CLI provides a terminal workflow for installing agents, checking installed versions, starting and stopping collectors, running manual checks, and retrieving current status for monitored resources.
Install And Authenticate
- Install the Bitaic CLI from your organization's installer or package distribution channel.
- Verify the installed CLI with
bitaic version. - Authenticate with a Bitaic token or login profile that has access to the account, organization, or project you want to manage.
- Store credentials outside committed configuration files and rotate them according to your security guidance.
Command Summary
| Command | Purpose | Arguments | Expected output | Related docs |
|---|---|---|---|---|
bitaic help | Display CLI help and available command groups. | Optional command name or group. | Help text and command list. | CLI reference. |
bitaic version | Show the installed CLI version. | None. | CLI version string. | CLI installation. |
bitaic install agent endpoint | Install the endpoint monitoring agent. | Endpoint agent name. | Install status and next command. | Endpoint Monitoring and SSL Monitoring. |
bitaic install agent health | Install the health monitoring agent. | Health agent name. | Install status and next command. | Health Monitoring. |
bitaic agent start <agent_name> | Start a monitoring agent. | Agent name, such as endpoint or health. | Agent status, start result, and next check. | Agent-backed product pages. |
bitaic agent stop <agent_name> | Stop a monitoring agent. | Agent name, such as endpoint or health. | Stop result and final agent status. | Agent-backed product pages. |
bitaic agent status <agent_name> | Inspect whether an agent is running and sending data. | Agent name, such as endpoint or health. | Running state, last check, and configuration status. | Agent-backed product pages. |
bitaic endpoint check <url> | Run a manual endpoint availability check. | Endpoint URL. | Availability, response time, uptime state, and alert state. | Endpoint Monitoring. |
bitaic health status | Retrieve current host health metrics. | None. | Host, agent status, CPU, memory, disk, and alert state. | Health Monitoring. |
bitaic update agent | Trigger or inspect the default agent update workflow. | None. | Update status and next action. | Agent update workflow. |
bitaic update agent all | Update all installed agents. | Literal all. | Per-agent update results. | Agent update workflow. |
bitaic update agent <agent_name> | Update a specific agent. | Agent name. | Update result for the selected agent. | Agent update workflow. |
bitaic agent version <agent_name> | Show the installed version for a specific agent. | Agent name. | Agent version string. | Agent update workflow. |
Product Command Coverage
| Product area | Current command status | Related product page |
|---|---|---|
| Endpoint Monitoring | Commands support installing, starting, checking status, and manually checking a URL. | Endpoint Monitoring |
| SSL Monitoring | Uses the endpoint agent workflow when certificate checks are enabled for HTTPS endpoints. | SSL Monitoring |
| Health Monitoring | Commands support installing, starting, checking agent status, and retrieving health status. | Health Monitoring |
| Domain Monitoring | Supports adding, listing, checking, and removing monitored domains through Bitaic management workflows. | Domain Monitoring |
| DNS Monitoring | Supports running DNS checks and managing configured DNS checks through Bitaic management workflows. | DNS Monitoring |
| Windows Event Monitoring | Supports inspecting Windows Event Monitoring status and event collection health. | Windows Event Monitoring |
Examples And Expected Output
The examples below show common CLI output shapes for version checks, agent installation, agent status, manual endpoint checks, health status, and agent updates.
$ bitaic version
version: <installed-version>$ bitaic install agent endpoint
agent: endpoint
status: installed
next: bitaic agent start endpoint$ bitaic agent status endpoint
agent: endpoint
status: running
configured_targets: 1
last_check: 2026-08-18T14:30:00Z$ bitaic endpoint check https://your-domain.com
url: https://your-domain.com
availability: up
response_time_ms: 248
uptime_state: available
alert_state: clear
checked_at: 2026-08-18T14:30:00Z$ bitaic health status
host: app-server-01
agent_status: running
cpu_usage: 42%
memory_usage: 68%
disk_usage: 71%
disk_io: normal
alert_state: clear
checked_at: 2026-08-18T14:30:00Z$ bitaic update agent all
status: complete
updated_agents:
- endpoint
- health
next: bitaic agent version <agent_name>Configuration And Environment
| Input | Purpose | Notes |
|---|---|---|
endpoint-agent-config.yml | Stores monitored endpoint URLs and SSL alert windows for endpoint and SSL workflows. | Use this file for endpoint and certificate check inputs. |
health-agent-config.yml | Stores health metric toggles for CPU, memory, disk usage, and disk I/O. | Use this file for host metric collection inputs. |
update-agent-config.yml | Stores update workflow settings for installed agents. | Use this file for agent update behavior. |
| CLI auth profile | Connects CLI commands to the correct Bitaic account, organization, or project. | Use profiles to target the correct Bitaic workspace. |
Errors And Recovery
| Error pattern | Likely cause | Recovery |
|---|---|---|
| Unknown command | The command or subcommand is not supported by this CLI build. | Run bitaic help and verify the installed version. |
| Authentication missing or expired | The CLI does not have a valid token or login session. | Re-authenticate and confirm the active account or profile. |
| Agent is not installed | The requested agent is missing from the host. | Install the agent, then run bitaic agent status <agent_name>. |
| Agent is stopped or stale | The agent is not running or has not reported recently. | Start the agent, confirm host permissions, and review network access to Bitaic. |
| Configuration parse error | A YAML file has invalid syntax or unsupported fields. | Validate the relevant config file and remove unsupported fields. |
| Monitoring target check fails | The endpoint, host, DNS record, or monitored target is failing. | Use the related product page to inspect expected data, threshold behavior, and troubleshooting steps. |
Scripting And CI Use
Automation should treat non-success command results as a reason to stop or alert. Scripts should log the full CLI output so operators can troubleshoot agent state, authentication, and monitored target failures.
bitaic version
bitaic agent status endpoint
bitaic endpoint check https://your-domain.com
bitaic health status