Structum CLI

Source Code AI Governance

The structum CLI is the official command-line interface for the Structum Framework. It centralizes development workflows, code quality checks, and plugin management.

🚀 Installation

The CLI is included in the structum meta-package:

pip install structum

🛠️ Commands

check

Runs the Code Quality Suite. This command executes the standard linter and formatter checks to ensure compliance with Structum’s coding standards.

structum check

Steps Performed:

  1. Ruff: Lints the codebase for errors and style violations.

  2. Black: Checks (but does not modify) code formatting.

build-docs

Builds the project documentation using Sphinx.

structum build-docs

Output:

  • Generates static HTML files in docs/_build/html.

🔮 Future Roadmap

  • structum init: Bootstrap a new project.

  • structum plugin enable/disable: Manage installed plugins.

  • structum doctor: Diagnose environment issues.