Manual Installation of Owl¶

This document is intended for Owl users, introducing the pre-installation preparations, online installation, version-specific installation, offline installation of Owl CLI, and the verification methods after installation.

owl is the command name for Owl CLI. After installation, users can locally use owl to synchronize the tool catalog, view tool descriptions, and execute platform capabilities.

If the currently used AI tool supports executing terminal commands, and you wish to automatically complete Owl CLI installation, authentication configuration, tool catalog synchronization, and Owl Skill installation, you can use Automatic Installation.

Pre-installation Preparation¶

Before installation, prepare the following information:

OWL_REGISTRY_ENDPOINT must be filled with the Guance Center Owl CLI Endpoint corresponding to the site where the workspace belongs. Do not manually append /api/v1.

• OWL_INSTALL_BASE_URL is used to download the installation script and installation package
• OWL_REGISTRY_ENDPOINT is used for CLI to access the Owl service of the Guance Center
• OWL_TOKEN is the service access token, used to identify the caller's identity, corresponding to DF-API-KEY
• OWL_API_KEY is an alias environment variable for OWL_TOKEN. When both are set, OWL_API_KEY takes precedence

Permission Requirements¶

OWL_TOKEN uses the Guance API Key. The accessible resources and executable operations of Owl CLI depend on the Open API permissions of this API Key.

Installation and initial verification require at least the following conditions:

• Can access the current workspace
• Can access the Owl CLI Endpoint
• Has the basic access permissions required to synchronize the tool catalog
• To execute specific tools, the API Key also needs to have read or write permissions for the corresponding Open API

Endpoint List¶

Owl CLI service provides independent Endpoints by site. Please select the corresponding service address based on the site where your workspace is located.

Supported Platforms¶

The current installation package supports the following platforms:

The installation package filename uses owl-cli-*, and the command after installation is uniformly owl.

Online Installation¶

Linux / macOS¶

OWL_INSTALL_BASE_URL="https://static.guance.com/owl" \
OWL_REGISTRY_ENDPOINT="https://owl-api.guance.com" \
OWL_TOKEN="your-token" \
bash -c "$(curl -fsSL https://static.guance.com/owl/install.sh)" -- --yes

Before execution, confirm that the system has installed the following commands:

• bash
• curl
• tar

Windows¶

$env:OWL_INSTALL_BASE_URL = "https://static.guance.com/owl"
$env:OWL_REGISTRY_ENDPOINT = "https://owl-api.guance.com"
$env:OWL_TOKEN = "your-token"
Set-ExecutionPolicy Bypass -Scope Process -Force
Import-Module BitsTransfer
Start-BitsTransfer -Source "$env:OWL_INSTALL_BASE_URL/install.ps1" -Destination .\owl-install.ps1
powershell .\owl-install.ps1 -Yes

If the system does not provide BitsTransfer, use the following command to download the script:

Invoke-WebRequest -Uri "$env:OWL_INSTALL_BASE_URL/install.ps1" -OutFile .\owl-install.ps1

Version-Specific Installation¶

If you need to install a specific version, you can specify the version number in the installation command.

If you need to install a specific version, you can specify the version number in the installation command.

Linux / macOS¶

OWL_INSTALL_BASE_URL="https://static.guance.com/owl" \
OWL_REGISTRY_ENDPOINT="https://owl-api.guance.com" \
OWL_TOKEN="your-token" \
bash -c "$(curl -fsSL https://static.guance.com/owl/install.sh)" -- --version "1.0.0" --yes

Windows¶

$env:OWL_INSTALL_BASE_URL = "https://static.guance.com/owl"
$env:OWL_REGISTRY_ENDPOINT = "https://owl-api.guance.com"
$env:OWL_TOKEN = "your-token"
Set-ExecutionPolicy Bypass -Scope Process -Force
Import-Module BitsTransfer
Start-BitsTransfer -Source "$env:OWL_INSTALL_BASE_URL/install.ps1" -Destination .\owl-install.ps1
powershell .\owl-install.ps1 -Version "1.0.0" -Yes

Offline Installation¶

In environments where online installation addresses cannot be accessed, you can use the offline installation method.

The offline installation directory must contain the following files:

• install.sh or install.ps1
• version
• SHA256SUMS
• The installation package corresponding to the current system

The offline installation package filenames are as follows:

Linux / macOS¶

chmod +x ./install.sh
./install.sh \
  --local-package \
  --registry-endpoint "https://owl-api.guance.com" \
  --token "your-token" \
  --yes

Windows¶

powershell .\install.ps1 `
  -LocalPackage `
  -RegistryEndpoint "https://owl-api.guance.com" `
  -Token "your-token" `
  -Yes

Default Directories After Installation¶

Executable File¶

Configuration Directory¶

To customize the configuration directory, you can set the environment variable OWL_DIR. When OWL_DIR is set to a non-empty value, Owl CLI will use this directory as the configuration directory, overriding the default paths in the table above; when not set, it falls back to the default paths in the table above ($HOME/.owl / %USERPROFILE%\.owl).

After initialization, the configuration directory contains the following:

Verification After Installation¶

After installation, reopen the terminal and execute the following commands:

owl --help
owl config show

If the commands can output help information and current configuration normally, it indicates that the local executable file and configuration files are ready.

To further verify the connectivity between the current terminal and the Owl CLI Endpoint, you can continue to execute:

owl sync

If owl sync can complete normally, it indicates that the current terminal can access the Owl CLI Endpoint, and the OWL_TOKEN can be used to synchronize the tool catalog.

If owl sync returns authentication, permission, or network errors, please refer to Troubleshooting.

Upgrade¶

To upgrade to a new version, you can re-execute the online installation command; to upgrade to a specific version, please refer to Version-Specific Installation.

Before upgrading, it is recommended to confirm the following:

• The current terminal is using the OWL_REGISTRY_ENDPOINT corresponding to the target workspace
• The current OWL_TOKEN is still valid
• Whether scripts or automated tasks on this machine rely on the behavior of the old version

Uninstallation¶

To uninstall Owl CLI, you can delete the Owl executable file and the local configuration directory.

Deleting the configuration directory will clear the local Token, cache, data files, and logs. Please confirm that these contents are no longer needed before deletion.

Installing Companion Skill for Agent (Optional)¶

If you plan to use the diagnostic capabilities of the Guance Center through Owl in an AI Agent, it is recommended to install the companion owl-diagnostics skill for the Agent after completing Owl CLI installation and executing owl sync once.

The owl-diagnostics skill depends on the owl command being installed and executable on the local machine. After installation, the Agent can combine with the tool catalog synchronized by Owl to more stably complete diagnostic analysis of logs, metrics, events, traces, etc.

Corresponding skill address:

https://github.com/GuanceCloud/ai-skills/tree/main/owl-diagnostics

If you currently only need to use Owl CLI manually, you can skip this step.

Taking Codex as an Example

In Codex, you can install the owl-diagnostics skill with the following prompt:

Help me install this skill: https://github.com/GuanceCloud/ai-skills/tree/main/owl-diagnostics

After installation, restart Codex to make the newly installed skill effective. Subsequently, when performing tasks related to Guance diagnostics in Codex, Codex can combine the local owl command with this skill.

When the terminal prompts that owl cannot be found, handle it as follows:

• Windows: Close the current PowerShell, reopen it, and then execute again
• Linux / macOS: Close the current terminal window, reopen it, and then execute again