OpenStrate CLI Reference

The OpenStrate CLI (ostr) is the primary tool for managing the entire OpenStrate ecosystem, from satellites and constellations to missions and workflows.

Installation

The CLI is typically installed as part of the OpenStrate development environment.

pip install openstrate-cli
# or dev install
pip install -e openstrate-cli

Global Options

• --help: Show help message and exit.

Core Commands

ostr scan

Scan for OpenStrate services and satellites on the network.

Usage:

ostr scan [OPTIONS]

Options:

• --timeout INTEGER: Scan timeout in seconds [default: 5]
• --json: Output results in JSON format

ostr recon

Perform a "Deep Discovery" (Reconnaissance) of the network.

Usage:

ostr recon [OPTIONS]

Description: Unlike scan, which relies on fast mDNS broadcasts, recon performs an active sweep and handshake with discovered services to verify their health and configuration. This is useful for debugging connectivity issues on complex networks.

ostr view

Launch the Aperture UI (Studio) dashboard.

Usage:

ostr view [OPTIONS]

Description: Starts the openstrate-aperture container to visualize the system.

Options:

• --force, -f: Force rebuild/recreate the aperture container.
• --port, -p INTEGER: Target port (0 for dynamic) [default: 0].

ostr reset

Reset the entire OpenStrate ecosystem.

Usage:

ostr reset [OPTIONS]

Description: Gracefully stops all services and restarts them.

Options:

• --satellites, -s INTEGER: Number of satellites to redeploy [default: 2].
• --build, -b: Rebuild service images.
• --hard: Prune all volumes and images (Hard Reset).

ostr status

Show the status dashboard.

Usage:

ostr status

Description: Displays a TUI dashboard of OpenStrate services, satellites, and mission status.

Satellite Management (ostr sat)

Manage Satellite Infrastructure.

ostr sat deploy

Deploy a new satellite.

Usage:

ostr sat deploy [OPTIONS]

Options:

• --count, -n INTEGER: Number of satellites to launch [default: 1].
• --jail / --no-jail: Enable/disable Bubblewrap jailing [default: jail enabled].
• --gpu / --no-gpu: Enable/disable GPU support.

TIP

Windows/Remote Nodes: While ostr sat deploy works for local containers, use the launch_satellite.sh script for remote or Windows-based nodes to ensure proper port mapping and discovery.

ostr sat list

List active satellites.

Usage:

ostr sat list

ostr sat down

Stop satellite(s).

Usage:

ostr sat down [OPTIONS] [SAT_ID]

Options:

• --all: Stop all satellites.

ostr sat logs

View satellite logs.

Usage:

ostr sat logs [SAT_ID]

Constellation Management (ostr const)

Constellation Operations (Fleet Management).

ostr const up

Deploy the Constellation Service (Registry).

Usage:

ostr const up

ostr const down

Stop the Constellation Service.

Usage:

ostr const down

ostr const list

Query the Constellation Registry for active satellites.

Usage:

ostr const list

ostr const reset

Reset the constellation.

Usage:

ostr const reset [OPTIONS]

Options:

• --demo: Factory reset (clears Jails + Workspace).

Relay Operations (ostr relay)

Relay Operations (Registry/Artifacts).

ostr relay up

Deploy the Relay Service.

Usage:

ostr relay up

ostr relay list

List packages and artifacts in the registry.

Usage:

ostr relay list

ostr relay seed-package

Seed a Python package to the registry.

Usage:

ostr relay seed-package [PACKAGE_NAME]

ostr relay seed-model

Seed a HuggingFace model.

Usage:

ostr relay seed-model [MODEL_ID]

Uplink Operations (ostr uplink)

Uplink Operations (AI & Packages).

ostr uplink up

Deploy the Uplink Service.

Usage:

ostr uplink up

Mission Control (ostr mission)

Mission & Workflow Control.

ostr mission init

Create boilerplate mission.py and workflow.yaml.

Usage:

ostr mission init

ostr mission deploy

Deploy a mission.

Usage:

ostr mission deploy [OPTIONS] [SCRIPT]

Options:

• --sat STRING: Target specific satellite ID.
• --auto: Use intelligent scheduling.

ostr mission list

List active/past missions.

Usage:

ostr mission list

ostr mission results

Fetch mission results.

Usage:

ostr mission results [JOB_ID]

Ghost Management (ostr ghost)

Manage Ghost (Duplicate/Stale) Services.

ostr ghost scan

Scan for duplicate services.

Usage:

ostr ghost scan

ostr ghost prune

Terminate all stale ghost services.

Usage:

ostr ghost prune