Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (55 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

76 lines (55 loc) · 2.34 KB
Raw

Contributing to Omnigent

Thanks for your interest in improving Omnigent. Issues and pull requests are welcome. For larger changes, open an issue first so we can discuss the approach.

Please don't include secrets, internal URLs, customer data, or private configuration in issues, tests, examples, or logs.

Development setup

This is a Python package with an optional frontend under ap-web/. Use uv for local development:

Install local prerequisites first:

  • uv for Python environments and dependency management.
  • tmux, required for native Claude/Codex terminals launched by the local host (brew install tmux on macOS, or apt install tmux on Debian/Ubuntu).
  • Node.js 22 LTS or newer with npm when working on ap-web/.
git clone https://github.com/omnigent-ai/omnigent.git
cd omnigent

uv python install
uv venv --python "$(cat .python-version)"
uv sync --extra all --extra dev
source .venv/bin/activate    # or prefix commands with `uv run`

Common checks:

uv run pytest                      # Python tests (e2e/live skipped by default)
uv run ruff check . && uv run ruff format --check .
uv run pre-commit run --all-files

When touching ap-web/:

cd ap-web && npm install && npm run lint && npm run build

Running locally

To try your changes, start a local server, register your machine as a host, and run the frontend dev server. Use three separate terminals:

# Terminal 1: local server on :6767
omnigent server

# Terminal 2: register your machine as a host
omnigent host --server http://localhost:6767

# Terminal 3: frontend dev server
cd ap-web
npm run dev

Open the Vite URL from the frontend dev server, usually http://localhost:5173/. The host registration is what lets the web UI browse your filesystem and start new sessions on your machine — without it, the web UI is read/continue-only.

omni is an alias for omnigent, so omni host --server ... works too. The host URL can also be passed positionally (omnigent host http://localhost:6767). See the README for more on hosts, harnesses, and credentials.

Pull requests

  • Branch from main, keep changes focused, and include tests or docs when relevant.
  • Sign off your commits with git commit -s (Developer Certificate of Origin).