OpenHubble CLI

Command-line interface (CLI) tool built with Python for interacting with the Agent, enabling quick testing and data retrieval. Features include querying metrics, testing configurations, and debugging.. Includes installation, update, and uninstallation guides.

Installing the CLI

To install the OpenHubble CLI, follow these steps:

1. Download and Run the Installation Script

Use curl to fetch the installation script and run it with root privileges:

curl -s https://get.openhubble.com/cli | sudo bash

This script will:

• Update your system's packages.
• Install required dependencies (git, python3, python3-venv, and python3-pip).
• Clone the OpenHubble CLI repository.
• Set up the required directories and configurations.
• Create a Python virtual environment and install the necessary Python modules.

2. Verify Installation

To confirm the cli is installed, use:

openhubble-cli

Now the tool must be appire!

---

Running the CLI with Docker

You can also run the OpenHubble CLI without installing it by using Docker:

1. Pull the Docker Image

docker pull openhubble/cli

2. Run Commands with Docker

You can execute the CLI commands directly using Docker:

docker run --rm openhubble/cli ping --host llm.example.com --port 9703 --key the-apikey-in-agent-config

Another example:

docker run --rm openhubble/cli get --host llm.example.com --port 7788 --key the-apikey-in-agent-config --metric hostname

This allows you to use the CLI without installing dependencies on your system.

---

Available Commands

You can use commands to ping the agent, get a specific metric from the agent, update, or uninstall. Let's begin.

Note!

If you are running your Agent over https just add --https at the end or anywhere of your command!

Remember that choosing protocol is available on both get and ping commands.

By default, the choosed protocol is http.

Ping Agent

To check if the agent is running, use:

openhubble-cli ping --host <host> --port <port> --key <api-key> --<protocol>

Example:

openhubble-cli ping --host llm.example.com --port 9703 --key the-apikey-in-agent-config --http

If the agent is running, the response will be:

Agent is running.

If there is an issue, an error message will be displayed.

Default values:

• host: 127.0.0.1
• port: 9703

Get Metric

To retrieve a specific metric from the agent, use:

openhubble-cli get --host <host> --port <port> --key <api-key> --metric <metric>

Example:

openhubble-cli get --host llm.example.com --port 7788 --key the-apikey-in-agent-config --metric hostname --https

This might return:

SRV_LLM_PROD

Another example:

openhubble-cli get --metric agent.version

This could return:

1.2.0

Default values:

• host: 127.0.0.1
• port: 9703
• metric: hostname

Show Version

To check the version of the OpenHubble CLI:

openhubble-cli version

This will display the current version of the OpenHubble CLI.

Show Help

To view the help documentation and available commands:

openhubble-cli help

This will show the usage information for the tool, including all available subcommands.

---

Updating the CLI

The OpenHubble CLI can be updated using the built-in commands. Run the following command with root privileges:

sudo openhubble-cli update

This will:

• Pull the latest updates from the repository.
• Update Python dependencies.

---

Uninstalling the CLI

To uninstall the OpenHubble CLI, use the built-in CLI commands:

sudo openhubble-cli uninstall

This will:

• Remove directories, and configuration files.

---

OpenHubble CLI

Command-line interface (CLI) tool built with Python for interacting with the Agent, enabling quick testing and data retrieval. Features include querying metrics, testing configurations, and debugging.. Includes installation, update, and uninstallation guides.

Installing the CLI

To install the OpenHubble CLI, follow these steps:

1. Download and Run the Installation Script

Use curl to fetch the installation script and run it with root privileges:

curl -s https://get.openhubble.com/cli | sudo bash

This script will:

• Update your system's packages.
• Install required dependencies (git, python3, python3-venv, and python3-pip).
• Clone the OpenHubble CLI repository.
• Set up the required directories and configurations.
• Create a Python virtual environment and install the necessary Python modules.

2. Verify Installation

To confirm the CLI is installed, use:

openhubble-cli

Now the tool must be available!

---

Building the Docker Image (For Development)

If you want to build the Docker image yourself, follow these steps:

1. Clone the Repository

git clone https://github.com/OpenHubble/cli.git
cd cli

2. Build the Docker Image

docker build -t oh-cli:1 .

3. Run the CLI Using the Built Image

docker run --rm oh-cli:1 ping --host 127.0.0.1 --port 9703

This is useful for local development and testing.

---

Attribution

If you modify or redistribute the OpenHubble CLI, you must include a reference to "OpenHubble" as the original creator of the project. This ensures that our startup is credited for the work and contributions made to the software.

Example attribution:

This software was modified from the original **OpenHubble CLI** (https://github.com/OpenHubble/cli).

---

OpenHubble by Amirhossein Mohammadi - 2025