---
id: onyx-devtools
version: "0.12.0"
license: unclear
license_treatment: permissive
maintenance: active
---

# onyx-devtools — Developer utilities for working on onyx.app

License: permissive · Maintenance: active · Downloads: 243.4K/mo

## What it is and what it does

Onyx-devtools is a command-line utility (`ods`) packaged as a Python wheel that provides developer automation for the Onyx project. It wraps and orchestrates common development tasks including Docker container lifecycle management (compose, logs, pull), backend service startup (API server, model server), frontend script execution, devcontainer management, database administration, and OpenAPI schema generation. The tool depends on fastapi and openapi-generator-cli.

The package is designed for developers working within the Onyx repository. It reduces friction by providing a single entry point for multi-step development workflows—launching containerized services, managing database migrations, running backend servers with environment configuration, and executing CI/CD operations. Shell completion is available for bash, fish, PowerShell, and zsh. Many commands require external tools (Docker, uv, GitHub CLI, AWS CLI) to be installed and configured separately, making it primarily useful for developers already invested in the Onyx development environment.

Use it for:

- Launch and manage Onyx Docker containers in dev or multitenant configuration without manually writing compose commands
- Start FastAPI backend services with environment variables pre-loaded from .vscode/.env without manual uvicorn setup
- View and follow logs from running services with tab-completion for service names
- Run database migrations, dumps, and restores without direct SQL or CLI tool invocation
- Generate OpenAPI schemas and client code for the Onyx API
- Manage devcontainer lifecycle (start, shell access, rebuild) for containerized development

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

A command-line utility that provides developer tools for the Onyx project, including Docker container management, backend service orchestration, database administration, and OpenAPI schema generation.

Yes, if you are an active Onyx contributor. The package is actively maintained (released 2026-08-14), has no known vulnerabilities, and significantly reduces friction for common development workflows. Install friction is moderate due to platform-specific wheels and external tool dependencies, but these are expected for a developer utility. Not recommended for non-Onyx use cases.

## Install

pip install onyx-devtools
uv add onyx-devtools
poetry add onyx-devtools

## Installing onyx-devtools

Before you install: Medium install friction due to compiled wheels for multiple platforms (macOS, Linux, Windows, ARM64). The package is actively maintained with a recent release and no known vulnerabilities. Runtime dependencies on fastapi and openapi-generator-cli add setup complexity.

License in practice: Licensed under MIT (permissive), allowing free use, modification, and distribution with minimal restrictions.

Quickstart:

pip install onyx-devtools
ods --help
ods compose dev
ods backend api

Requires Python >=3.9. Many commands require external tools: Docker (for compose/logs/pull), uv (for backend commands), GitHub CLI (for run-ci/cherry-pick/trace), AWS CLI (for screenshot-diff). See package description for installation links.

Verify before relying:

- Whether openapi-generator-cli is a runtime dependency or an optional tool that must be installed separately
- Whether the package works outside the Onyx repository context or is tightly coupled to the Onyx project structure
- Performance characteristics and typical command execution times

## Package facts

- License: not declared (permissive)
- Python support: supports_current
- Install friction: medium
- Maintenance: active
- Downloads: 243.4K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

onyx development tools, docker compose cli wrapper, backend service management, developer utility script, onyx devtools cli, fastapi development helpers, database migration tools, cli-tool, docker-orchestration, onyx-ecosystem

[View on SkillFed](https://skillfed.io/packages/onyx-devtools) · [View on PyPI](https://pypi.org/project/onyx-devtools/)