CLI Reference

The Open Geodata API provides a comprehensive command-line interface (CLI) through the ogapi command, enabling users to interact with satellite data APIs easily from the terminal.

• Collections Command
• Search CLI Commands
  • Basic Usage
  • Commands Overview
  • Advanced Search Patterns
  • Working with Search Results
  • Error Handling and Troubleshooting
• Item Management CLI Commands
  • Basic Usage
  • Commands Overview
  • Advanced Item Operations
  • Working with Multiple Items
  • Error Handling and Troubleshooting
  • Integration with Other Commands
• Download CLI Commands
  • Basic Usage
  • Commands Overview
  • Advanced Download Features
  • Performance Optimization
  • Error Handling and Troubleshooting
  • Workflow Integration
• Utility CLI Commands
  • Basic Usage
  • Commands Overview
  • Advanced Utility Operations
  • Integration with External Tools
  • Error Handling and Troubleshooting
• Workflow CLI Commands
  • Basic Usage
  • Commands Overview
  • Advanced Workflow Features
  • Integration and Automation
• Workflow CLI Commands (Continued)
  • Monitoring and Alerting
  • Error Handling and Recovery
  • Performance Optimization
  • Security and Compliance
  • Workflow Templates
  • Troubleshooting Workflows
  • Best Practices Summary

Overview

ogapi collections - Discover and explore satellite data collections ogapi search - Find satellite imagery with filters ogapi items - Work with individual scenes and assets ogapi download - Download satellite data intelligently ogapi utils - Utility commands for processing and analysis ogapi workflows - Predefined workflows for common tasks

Usage

# Show general help
ogapi --help

# Show help for a specific command group
ogapi collections --help

# Show help for a specific command
ogapi search items --help

Examples

# List all collections
ogapi collections list

# Search for Sentinel-2 data
ogapi search items --collections sentinel-2-l2a --bbox "-122.5,47.5,-122.0,48.0" --limit 5

# Download specific bands
ogapi download search-results search_results.json --assets "B04,B03,B02" --destination ./rgb_data/

# Filter search results by cloud cover
ogapi utils filter-clouds search_results.json --max-cloud-cover 20

# Run a predefined workflow
ogapi workflows seasonal-analysis --config seasonal_config.yaml