Skip to content

development.md

Latest commit

 

History

History
87 lines (63 loc) · 1.72 KB

development.md

File metadata and controls

87 lines (63 loc) · 1.72 KB

Development

Clone and install

git clone <repo-url>
cd komu-cli

Windows PowerShell

python -m venv .venv
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
.\.venv\Scripts\Activate.ps1
python -m pip install -e .[dev]

Linux / macOS

python3 -m venv .venv
source .venv/bin/activate
python -m pip install -e .[dev]

Run the CLI locally

komu --help
komu shell
komu providers list
komu providers capabilities

Module mode also works:

python -m komu_cli --help

Run validation

python -m compileall src
python -m unittest discover -s tests -p "test_*.py"

Package and release checks

python -m pip install -e .[release]
python -m build

Provider development notes

Useful local checks while working on provider integrations:

komu providers list
komu providers capabilities
komu providers health
komu providers check ollama
komu providers check openai-compatible

Use .env.example to seed provider configuration during development.

Provider security expectations:

  • keep provider trust defaults conservative
  • do not allow provider output to bypass plan review
  • keep secrets in environment variables or optional keyring, not plaintext config
  • add tests for malformed provider output, validation failures, and redaction behavior when hardening provider code

Development expectations

  • keep user-facing text and command names in English
  • preserve the layered separation between CLI and reusable services
  • add tests when fixing CLI flows or pure-service behavior
  • update install/path docs when packaging behavior changes

See also: