|
1 | | -@AGENTS.md |
2 | | -## AgentHub |
3 | | -- Central hub: `~/AgentHub/` |
4 | | -- Skills: `.agents/skills/` (symlinked to AgentHub shared skills) |
5 | | -- MCP: 12 servers synced across all agents |
6 | | -- Agents: 14 shared agents available |
7 | | -- Hooks: Safety, notification, and logging hooks |
| 1 | +# CLAUDE.md |
| 2 | + |
| 3 | +## Project: OpenShell |
| 4 | + |
| 5 | +**Organization:** AiFeatures (iAiFy Enterprise) |
| 6 | +**Language:** Rust + Python |
| 7 | +**Description:** Safe, private sandboxed runtime for autonomous AI agents with declarative YAML policy enforcement |
| 8 | + |
| 9 | +## Build & Test |
| 10 | + |
| 11 | +```bash |
| 12 | +# Install dependencies (Python) |
| 13 | +uv sync --all-extras --group dev |
| 14 | + |
| 15 | +# Install CLI binary |
| 16 | +uv pip install . |
| 17 | + |
| 18 | +# Build Rust crates |
| 19 | +cargo build |
| 20 | + |
| 21 | +# Test (Python) |
| 22 | +uv run pytest -v --tb=short |
| 23 | + |
| 24 | +# Test (Rust) |
| 25 | +cargo test |
| 26 | + |
| 27 | +# Pre-commit checks (lint + format + license headers) |
| 28 | +mise run pre-commit |
| 29 | + |
| 30 | +# Full local CI |
| 31 | +mise run ci |
| 32 | + |
| 33 | +# Lint (Python) |
| 34 | +uv run ruff check |
| 35 | + |
| 36 | +# Format (Python) |
| 37 | +uv run ruff format |
| 38 | + |
| 39 | +# E2E tests (requires running cluster) |
| 40 | +mise run e2e |
| 41 | +``` |
| 42 | + |
| 43 | +## Architecture |
| 44 | + |
| 45 | +```text |
| 46 | +crates/ |
| 47 | + openshell-cli/ # User-facing CLI binary |
| 48 | + openshell-server/ # Gateway control-plane API |
| 49 | + openshell-sandbox/ # Container supervision, policy-enforced egress |
| 50 | + openshell-policy/ # Filesystem, network, process, inference constraints |
| 51 | + openshell-router/ # Privacy-aware LLM routing |
| 52 | + openshell-bootstrap/ # K3s cluster setup, mTLS PKI |
| 53 | + openshell-ocsf/ # OCSF v1.7.0 structured logging |
| 54 | + openshell-core/ # Common types, config, error handling |
| 55 | + openshell-providers/ # Credential provider backends |
| 56 | + openshell-tui/ # Ratatui terminal dashboard |
| 57 | +python/openshell/ # Python SDK and CLI packaging |
| 58 | +proto/ # Protobuf / gRPC service contracts |
| 59 | +deploy/ # Docker, Helm, K8s manifests |
| 60 | +.agents/skills/ # Agent workflow automation |
| 61 | +.agents/agents/ # Sub-agent definitions |
| 62 | +architecture/ # Design decisions and component docs |
| 63 | +``` |
| 64 | + |
| 65 | +## Conventions |
| 66 | + |
| 67 | +- Conventional commits: `feat:`, `fix:`, `chore:`, `docs:`, `refactor:`, `test:`, `ci:`, `perf:` |
| 68 | +- Kebab-case file names |
| 69 | +- Branch protection on main -- PRs required |
| 70 | +- Always use `mise` commands over direct docker/cargo builds when available |
| 71 | +- Always use `uv` for Python commands |
| 72 | +- Run `mise run pre-commit` before every commit |
| 73 | +- OCSF structured logging for observable sandbox events; plain `tracing` for internal plumbing |
| 74 | +- Never mention AI agents in commit messages (no Co-Authored-By) |
| 75 | + |
| 76 | +## Shared Resources |
| 77 | + |
| 78 | +| Asset | Location | |
| 79 | +| --- | --- | |
| 80 | +| CI/CD workflows | Ai-road-4-You/enterprise-ci-cd@v1 | |
| 81 | +| Composite actions | Ai-road-4-You/github-actions@v1 | |
| 82 | +| Governance | Ai-road-4-You/governance | |
| 83 | + |
| 84 | +## Fork Info |
| 85 | + |
| 86 | +- Upstream: NVIDIA/OpenShell |
| 87 | +- Do NOT create PRs to upstream |
| 88 | +- Sync managed by Ai-road-4-You/fork-sync |
| 89 | +- Divergence is intentional where documented in README iAiFy Fork Notes |
0 commit comments