OQTOPUS CLI (Command Line Interface)

Overview

OQTOPUS CLI is a command line interface for setting up and operating local OQTOPUS environments.

The CLI provides a single oqtopus command for the common lifecycle of local environments: create an environment, install component releases, start, stop, and restart services, inspect status, and clean up unused installations. It is designed to make OQTOPUS operation feel closer to familiar developer tools such as package managers and service managers, while keeping the underlying configuration files available for users who need to edit them. The CLI itself can be installed with a single command.

Two environment templates are supported:

• cloud-local — for OQTOPUS Cloud running locally (cloud, frontend, admin)
• backend — for the OQTOPUS backend (engine, tranqu, gateway)

With OQTOPUS CLI, users can:

• create a backend or cloud-local environment from the official template;
• install and update components directly from their GitHub releases;
• start, stop, and restart managed services;
• check process status and environment information;
• keep installed component releases in a shared local data directory so that multiple environments reuse the same installation without duplication;
• manage per-environment configuration files separately from the shared component installations;
• prepare runtime directories such as logs and PID files for local execution.

Currently, the CLI targets Linux and macOS local workflows. Windows is not supported. A future Rust implementation is planned separately.

Usage

If you are using OQTOPUS CLI for the first time, start here:

1. Installation
2. Quick Start

Cloud-local environment:

• Cloud-Local Environment
• Cloud-Local Configuration
• Managing Cloud-Local Components
• Starting and Stopping Cloud-Local Services

Backend environment:

• Backend Environment
• Backend Configuration
• Managing Backend Components
• Starting and Stopping Backend Services
• Backend Device Status

Reference and tools:

• Command Reference
• Shell Completion
• Troubleshooting

Developer Guidelines

• Development Flow
• Setup Development Environment
• How to Contribute
• Code of Conduct
• Security

Citation

Citation information is also available in the CITATION file.

Contact

You can contact us by creating an issue in this repository or by email:

• oqtopus-team[at]googlegroups.com

License

OQTOPUS CLI is released under the Apache License 2.0.