sfeos-tools 0.1.1

CLI tools for managing stac-fastapi-elasticsearch-opensearch deployments

SFEOS Tools

CLI tools for managing stac-fastapi-elasticsearch-opensearch deployments.

Table of Contents

• Installation
  • For Elasticsearch
  • For OpenSearch
  • For Development
• Usage
• Commands
  • add-bbox-shape
  • reindex
• Development
• License

Installation

For Elasticsearch

pip install sfeos-tools[elasticsearch]

Or for local development:

pip install -e sfeos_tools[elasticsearch]

For OpenSearch

pip install sfeos-tools[opensearch]

Or for local development:

pip install -e sfeos_tools[opensearch]

For Development (both backends)

pip install sfeos-tools[dev]

Or for local development:

pip install -e sfeos_tools[dev]

Usage

After installation, the sfeos-tools command will be available:

# View available commands
sfeos-tools --help

# View version
sfeos-tools --version

Commands

add-bbox-shape

Adds a bbox_shape field to existing collections for spatial search support. This migration is required for collections created before spatial search was added. Collections created or updated after this feature will automatically have the bbox_shape field.

sfeos-tools add-bbox-shape --backend [elasticsearch|opensearch] [options]

Options:

• --backend: Database backend to use (required, choices: elasticsearch, opensearch)
• --host: Database host (default: localhost or ES_HOST env var)
• --port: Database port (default: 9200 for ES, 9202 for OS, or ES_PORT env var)
• --use-ssl/--no-ssl: Use SSL connection (default: true or ES_USE_SSL env var)
• --user: Database username (default: ES_USER env var)
• --password: Database password (default: ES_PASS env var)

reindex

Reindexes all STAC indexes to the next version and updates aliases. This command performs the following actions:

• Creates/updates index templates
• Reindexes collections and item indexes to a new version
• Applies asset migration script for compatibility
• Switches aliases to the new indexes

sfeos-tools reindex --backend [elasticsearch|opensearch] [options]

Options:

• --backend: Database backend to use (required, choices: elasticsearch, opensearch)
• --host: Database host (default: localhost or ES_HOST env var)
• --port: Database port (default: 9200 for ES, 9202 for OS, or ES_PORT env var)
• --use-ssl/--no-ssl: Use SSL connection (default: true or ES_USE_SSL env var)
• --user: Database username (default: ES_USER env var)
• --password: Database password (default: ES_PASS env var)
• --yes: Skip confirmation prompt

Example:

# Reindex Elasticsearch with custom host and no SSL
sfeos-tools reindex --backend elasticsearch --host localhost --port 9200 --no-ssl

# Reindex OpenSearch with default settings
sfeos-tools reindex --backend opensearch

Get help for a specific command

sfeos-tools add-bbox-shape --help

## Commands

### add-bbox-shape

Add `bbox_shape` field to existing collections for spatial search support.

**Basic usage:**

```bash
# Elasticsearch
sfeos-tools add-bbox-shape --backend elasticsearch

# OpenSearch
sfeos-tools add-bbox-shape --backend opensearch

Connection options:

# Local Docker Compose (no SSL)
sfeos-tools add-bbox-shape --backend elasticsearch --no-ssl

# Remote server with SSL
sfeos-tools add-bbox-shape \
  --backend elasticsearch \
  --host db.example.com \
  --port 9200 \
  --user admin \
  --password secret

# Using environment variables
ES_HOST=my-cluster.cloud.com ES_PORT=9243 ES_USER=elastic ES_PASS=changeme \
  sfeos-tools add-bbox-shape --backend elasticsearch

Available options:

• --backend: Database backend (elasticsearch or opensearch) - required
• --host: Database host (default: localhost or ES_HOST env var)
• --port: Database port (default: 9200 or ES_PORT env var)
• --use-ssl / --no-ssl: Use SSL connection (default: true or ES_USE_SSL env var)
• --user: Database username (default: ES_USER env var)
• --password: Database password (default: ES_PASS env var)

Development

To develop sfeos-tools locally:

# Install in editable mode with dev dependencies
pip install -e ./sfeos_tools[dev]

# Run the CLI
sfeos-tools --help

# Run tests
pytest

# Format code
pre-commit install
pre-commit run --all-files