Install uv first, then:
# 0. Install the CLI (project + CLI extras into .venv)
git clone https://github.com/thealphacubicle/OpenContext.git
cd OpenContext
uv sync --extra cli
# 1. Check prerequisites (Python 3.11+, uv, AWS CLI, Terraform)
uv run opencontext authenticate
# 2. Configure interactively (creates config.yaml + Terraform workspace)
uv run opencontext configure
# 3. Test locally (optional)
uv run opencontext serve
# 4. Deploy
uv run opencontext deploy --env stagingConnect via Claude Connectors (same steps on both Claude.ai and Claude Desktop):
- Go to Settings → Connectors (or Customize → Connectors on claude.ai)
- Click Add custom connector
- Enter a name (e.g. "Your City OpenData") and your API Gateway URL (printed at the end of
opencontext deploy)
See Getting Started for full setup.
- Default workflow:
uv sync --extra cli(oruv sync --all-extrasfor development) installs frompyproject.tomland the lockfile into.venv. Run CLI and tools withuv run …when you want to use the project environment without activating the venv. requirements.txtis kept for Lambda packaging (opencontext deployinstalls withuv pip install … -r requirements.txt) and security scans in CI (e.g.uv run pip-audit -r requirements.txt). You usually do not install fromrequirements.txtby hand unless debugging those flows.
Details: Getting Started — full walkthrough (section Using uv with requirements.txt).
| Doc | Description |
|---|---|
| Getting Started | Setup and usage |
| CLI Reference | All CLI commands and flags |
| Architecture | System design and plugins |
| Built-in Plugins | CKAN, ArcGIS Hub, Socrata plugin details |
| Custom Plugins | How to write your own plugin |
| Deployment | AWS, Terraform, monitoring |
| Testing | Local testing (Terminal, Claude, MCP Inspector) |
Pre-commit hooks (optional):
uv sync --all-extras # includes pre-commit; use --extra cli if you only need the CLI
uv run pre-commit installHooks: Ruff, yamllint, gofmt. Run manually: uv run pre-commit run --all-files.
MIT — see LICENSE.
Author: Srihari Raman