https://github.com/oqtopus-team/oqtopus-cli
OQTOPUS CLI is a command line interface for preparing and operating a local OQTOPUS backend environment
https://github.com/oqtopus-team/oqtopus-cli
quantum quantum-computing
Last synced: 7 days ago
JSON representation
OQTOPUS CLI is a command line interface for preparing and operating a local OQTOPUS backend environment
- Host: GitHub
- URL: https://github.com/oqtopus-team/oqtopus-cli
- Owner: oqtopus-team
- License: apache-2.0
- Created: 2026-05-05T07:32:30.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-06-03T01:39:53.000Z (13 days ago)
- Last Synced: 2026-06-03T03:20:55.895Z (13 days ago)
- Topics: quantum, quantum-computing
- Language: Shell
- Homepage: https://oqtopus-cli.readthedocs.io/
- Size: 249 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# OQTOPUS CLI (Command Line Interface)
[](https://opensource.org/licenses/Apache-2.0)
[![slack](https://img.shields.io/badge/slack-OQTOPUS-pink.svg?logo=slack&style=plastic")](https://join.slack.com/t/oqtopus/shared_invite/zt-3bpjb7yc3-Vg8IYSMY1m5wV3DR~TMSnw)
## Overview
**OQTOPUS CLI** is a command line interface for preparing and operating local
OQTOPUS environments.
It gives OQTOPUS users a familiar command-line workflow for creating
environments, installing components, and starting or stopping local services
from one `oqtopus` command. Instead of manually arranging release archives,
configuration files, process IDs, and runtime directories, users can manage
local environments with package-manager-like commands.
**Cloud-local environment:**
```bash
oqtopus init demo --template cloud-local
oqtopus cloud-local install cloud
oqtopus cloud-local start user
oqtopus cloud-local status
oqtopus cloud-local stop user
```
**Backend environment:**
```bash
oqtopus init demo --template backend
oqtopus backend install engine
oqtopus backend start core
oqtopus backend status
oqtopus backend stop core
```
OQTOPUS CLI currently focuses on Linux and macOS local workflows.
A future Rust implementation is planned separately.
## Documentation
- [Documentation Home](https://oqtopus-cli.readthedocs.io/)
## Citation
Citation information is also available in the [CITATION](https://github.com/oqtopus-team/oqtopus-cli/blob/main/CITATION.cff) file.
## Contact
You can contact us by creating an issue in this repository or by email:
- [oqtopus-team[at]googlegroups.com](mailto:oqtopus-team[at]googlegroups.com)
## License
OQTOPUS CLI is released under the [Apache License 2.0](https://github.com/oqtopus-team/oqtopus-cli/blob/main/LICENSE).