shoreguard 0.1.0__tar.gz

shoreguard-0.1.0/.gitignore

@@ -0,0 +1,211 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Claude Code
+.claude/
+mutants/

shoreguard-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

shoreguard-0.1.0/PKG-INFO

@@ -0,0 +1,273 @@
+Metadata-Version: 2.4
+Name: shoreguard
+Version: 0.1.0
+Summary: Open source control plane for NVIDIA OpenShell
+Project-URL: Homepage, https://github.com/FloHofstetter/shoreguard
+Project-URL: Repository, https://github.com/FloHofstetter/shoreguard
+Project-URL: Issues, https://github.com/FloHofstetter/shoreguard/issues
+Author-email: Florian Hofstetter <flo.max.hofstetter@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai-agents,control-plane,nvidia,openshell,sandbox,security
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.12
+Requires-Dist: fastapi>=0.135
+Requires-Dist: grpcio>=1.78
+Requires-Dist: jinja2>=3.1
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: typer>=0.15
+Requires-Dist: uvicorn>=0.42
+Requires-Dist: websockets>=16.0
+Description-Content-Type: text/markdown
+
+# Shoreguard
+
+[![CI](https://github.com/FloHofstetter/shoreguard/actions/workflows/ci.yml/badge.svg)](https://github.com/FloHofstetter/shoreguard/actions/workflows/ci.yml)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-green.svg)](LICENSE)
+
+Open source control plane for [NVIDIA OpenShell](https://github.com/NVIDIA/OpenShell). A web-based GUI to manage AI agent sandboxes, security policies, and approval flows.
+
+> [!WARNING]
+> **Weekend project.** This UI was vibe-coded in a weekend as a proof of concept. It works, it has tests, but it is not production-hardened. There is no authentication, no rate limiting, and no audit logging. Use it for local development and demos — not to secure anything that matters.
+
+![Sandbox Overview](docs/screenshots/sandbox-overview.png)
+
+## What is this?
+
+OpenShell provides secure, sandboxed environments for AI agents (OpenClaw, Claude Code, Cursor, etc.). Shoreguard gives you a dashboard to:
+
+- **Manage sandboxes** — Create, monitor, and delete agent sandboxes
+- **Edit security policies** — Visual network policy editor instead of raw YAML
+- **Approve access requests** — iOS-style permission dialogs when agents try to reach blocked endpoints
+- **Live monitoring** — Real-time logs and events via WebSocket
+- **One-click setup** — Wizard to create sandboxes with pre-configured policy presets
+
+## Quick Start
+
+**Prerequisites:** Python 3.12+, a running [OpenShell](https://github.com/NVIDIA/OpenShell) gateway
+
+### Install from PyPI
+
+```bash
+pip install shoreguard
+shoreguard
+```
+
+### Install from source
+
+```bash
+git clone https://github.com/FloHofstetter/shoreguard.git
+cd shoreguard
+uv sync
+uv run shoreguard
+```
+
+Open [http://localhost:8888](http://localhost:8888) in your browser.
+
+> Shoreguard auto-discovers your OpenShell gateway via `~/.config/openshell/active_gateway`. If no gateway is configured, the UI loads but API calls will fail.
+
+### CLI Options
+
+```
+shoreguard --help
+shoreguard --port 9000 --host 127.0.0.1
+shoreguard --log-level debug --no-reload
+```
+
+| Flag | Env Variable | Default | Description |
+|------|-------------|---------|-------------|
+| `--host` | `SHOREGUARD_HOST` | `0.0.0.0` | Bind address |
+| `--port` | `SHOREGUARD_PORT` | `8888` | Bind port |
+| `--log-level` | `SHOREGUARD_LOG_LEVEL` | `info` | Log level (debug/info/warning/error) |
+| `--no-reload` | `SHOREGUARD_RELOAD` | reload on | Disable auto-reload |
+
+CLI arguments take priority over environment variables.
+
+## Features
+
+### Gateway Management
+
+Multi-gateway support with status monitoring, start/stop controls, and system diagnostics.
+
+![Gateways](docs/screenshots/gateways.png)
+
+### Policy Management
+
+Visual network policy editor with per-rule endpoint details and binary restrictions.
+
+![Network Policies](docs/screenshots/network-policies.png)
+
+- View and edit network policies per sandbox
+- Apply bundled presets with one click (PyPI, npm, Docker Hub, Slack, Discord, etc.)
+- Policy revision history with rollback capability
+
+### Approval Flow
+
+When an agent in a sandbox tries to access a blocked endpoint, OpenShell generates a draft policy recommendation. Shoreguard surfaces these as approval requests:
+
+- Review proposed network rules with rationale and security notes
+- Approve, reject, or edit individual rules
+- Bulk approve/reject with security-flagged chunk protection
+- Undo approved rules
+- Real-time WebSocket notifications for new approval requests
+
+### Sandbox Wizard
+
+Step-by-step sandbox creation with agent type selection, configuration, policy presets, and live launch progress.
+
+![Wizard](docs/screenshots/wizard.png)
+
+### Bundled Policy Presets
+
+| Preset | Description |
+|--------|-------------|
+| `pypi` | Python Package Index (pypi.org) |
+| `npm` | npm + Yarn registries |
+| `docker` | Docker Hub + NVIDIA Container Registry |
+| `huggingface` | HF Hub, LFS, and Inference API |
+| `slack` | Slack API and webhooks |
+| `discord` | Discord API, gateway, and CDN |
+| `telegram` | Telegram Bot API |
+| `jira` | Jira / Atlassian Cloud |
+| `outlook` | Microsoft Graph / Outlook |
+
+## Architecture
+
+```
+┌─────────────────────────────────────────────┐
+│  Browser (:8888)                            │
+│  ├── Dashboard        (Bootstrap 5 + JS)    │
+│  ├── Policy Editor                          │
+│  ├── Approval Flow                          │
+│  └── Sandbox Wizard                         │
+├─────────────────────────────────────────────┤
+│  Shoreguard API       (FastAPI)             │
+│  ├── REST endpoints   /api/*                │
+│  ├── WebSocket        /ws/{sandbox}         │
+│  └── Static files     /static/*             │
+├─────────────────────────────────────────────┤
+│  Service Layer        (Business Logic)      │
+│  ├── GatewayService   Docker, ports, health │
+│  ├── SandboxService   Create + presets      │
+│  ├── PolicyService    Rule CRUD, merge      │
+│  └── ProviderService  Types, credentials    │
+├─────────────────────────────────────────────┤
+│  Client Layer         (gRPC + mTLS)         │
+│  ├── SandboxManager   CRUD, exec, logs      │
+│  ├── PolicyManager    policies, presets      │
+│  └── ApprovalManager  draft policy flow     │
+├─────────────────────────────────────────────┤
+│  OpenShell Gateway    (gRPC)                │
+│  └── Docker / Kubernetes Sandboxes          │
+└─────────────────────────────────────────────┘
+```
+
+## API
+
+Shoreguard exposes a REST API on port 8888. Interactive docs are available at [/docs](http://localhost:8888/docs) (Swagger UI).
+
+### Key endpoints
+
+| Method | Path | Description |
+|--------|------|-------------|
+| `GET` | `/api/sandboxes` | List all sandboxes |
+| `POST` | `/api/sandboxes` | Create a sandbox |
+| `GET` | `/api/sandboxes/{name}` | Get sandbox details |
+| `DELETE` | `/api/sandboxes/{name}` | Delete a sandbox |
+| `POST` | `/api/sandboxes/{name}/exec` | Execute a command |
+| `GET` | `/api/sandboxes/{name}/policy` | Get active policy |
+| `PUT` | `/api/sandboxes/{name}/policy` | Update policy |
+| `GET` | `/api/sandboxes/{name}/approvals/pending` | Get pending approvals |
+| `POST` | `/api/sandboxes/{name}/approvals/{id}/approve` | Approve a request |
+| `POST` | `/api/sandboxes/{name}/approvals/{id}/reject` | Reject a request |
+| `GET` | `/api/policies/presets` | List available presets |
+| `WS` | `/ws/{name}` | Live sandbox events |
+
+## Development
+
+```bash
+# Install with dev dependencies
+uv sync --group dev
+
+# Run the server with auto-reload
+uv run shoreguard
+
+# Lint and format
+uv run ruff check .
+uv run ruff format --check .
+
+# Type checking
+uv run pyright
+
+# Unit tests
+uv run pytest -m 'not integration'
+
+# Integration tests (requires running OpenShell gateway)
+uv run pytest tests/integration/ -m integration
+
+# All tests
+uv run pytest
+
+# Mutation testing
+uv run mutmut run
+```
+
+### Test suite
+
+| Category | Tests | Description |
+|----------|-------|-------------|
+| Unit | 425 | Client managers, services, API routes, converters, CLI |
+| Integration | 35 | Live gRPC against real OpenShell gateway |
+| Mutation | 72% kill rate | Via mutmut, measures test quality |
+
+### OpenShell metadata (`openshell.yaml`)
+
+Shoreguard needs metadata about OpenShell that is not available via the gRPC API: provider types with their credential environment variables, inference provider profiles, and community sandbox templates.
+
+This metadata lives in [`shoreguard/openshell.yaml`](shoreguard/openshell.yaml). When OpenShell updates its provider registry or community sandbox list, update this file to match. The sync sources are documented at the top of the file:
+
+| Data | OpenShell source |
+|------|-----------------|
+| Provider types | `crates/openshell-providers/src/lib.rs` (`ProviderRegistry::new`) |
+| Credential keys | `crates/openshell-providers/src/<type>.rs` (discovery logic) |
+| Inference providers | `crates/openshell-core/src/inference.rs` (`profile_for`) |
+| Community sandboxes | `docs/sandboxes/community-sandboxes.md` |
+
+### Regenerating proto stubs
+
+If the OpenShell proto files change:
+
+```bash
+uv run python scripts/generate_proto.py /path/to/OpenShell/proto
+```
+
+## Roadmap
+
+- [ ] Multi-cluster support
+- [ ] Policy diff viewer
+- [ ] Audit log export
+- [ ] User authentication
+
+## Contributing
+
+1. Open an issue to discuss changes before submitting a PR
+2. Run the full check suite before pushing:
+
+```bash
+uv run ruff check . && uv run ruff format --check . && uv run pyright && uv run pytest -m 'not integration'
+```
+
+3. All CI checks must pass (lint, typecheck, tests on Python 3.12 + 3.13)
+
+## License
+
+[Apache 2.0](LICENSE)