scout

cloudzero-scout CLI

A command-line interface for CloudZero Scout that automatically detects and retrieves cloud environment information. This tool is useful for debugging cloud environment detection, validating metadata service connectivity, and integration testing.

Overview

The cloudzero-scout CLI provides an easy way to test and validate cloud environment auto-detection functionality. It supports multiple output formats and can be used for troubleshooting Scout integration issues in CloudZero Agent deployments.

Installation

Build from Source

# From the CloudZero Agent repository root
make build

# The binary will be available at:
# ./bin/cloudzero-scout

Using Go Install

# Install directly from source
go install github.com/cloudzero/cloudzero-agent/app/functions/scout

Usage

Basic Commands

# Get full environment information (default command)
cloudzero-scout

# Only detect cloud provider
cloudzero-scout detect

Command Reference

cloudzero-scout (default) or cloudzero-scout info

Retrieves complete cloud environment information including provider, region, and account ID.

Examples:

# Default JSON output
cloudzero-scout

# Table format output
cloudzero-scout --output table

# YAML format output
cloudzero-scout --output yaml

# With custom timeout
cloudzero-scout --timeout 30s

# Verbose output for debugging
cloudzero-scout --verbose

cloudzero-scout detect

Detects only the cloud provider without retrieving full metadata.

Examples:

# Detect cloud provider
cloudzero-scout detect

# Detect with table output
cloudzero-scout detect --output table

Global Flags

Output Formats

JSON (Default)

$ cloudzero-scout
{
  "CloudProvider": "aws",
  "Region": "us-east-1",
  "AccountID": "123456789012"
}

YAML

$ cloudzero-scout --output yaml
cloudProvider: aws
region: us-east-1
accountId: "123456789012"

Table

$ cloudzero-scout --output table
Cloud Provider : aws
Region         : us-east-1
Account ID     : 123456789012

Examples

AWS Environment

# Running on AWS EC2 instance
$ cloudzero-scout --output table --verbose
Initializing CloudZero Scout...
Timeout: 10s
Retrieving environment information...
Cloud Provider : aws
Region        : us-west-2
Account ID    : 975482786146

Provider Detection Only

# Quick provider detection
$ cloudzero-scout detect
aws

# With JSON output
$ cloudzero-scout detect --output json
{
  "cloudProvider": "aws"
}

Exit Codes

Related Documentation

• Scout Package Documentation - Core Scout package API
• CloudZero Agent Configuration - Main project documentation
• Build System - Build and development targets