From be9c57e22b9190bb5108c33f974563ed0f96ddaf Mon Sep 17 00:00:00 2001
From: ashsolei <ashkan.soleimani.m@gmail.com>
Date: Fri, 10 Apr 2026 13:33:37 +0200
Subject: [PATCH] docs: enrich CLAUDE.md with quickstart, conventions,
 architecture

---
 CLAUDE.md | 66 +++++++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 54 insertions(+), 12 deletions(-)

diff --git a/CLAUDE.md b/CLAUDE.md
index 43514659e..3076e1997 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -4,21 +4,63 @@ To re-generate the API client run `make codegen` in the repository root.
 Run tests on affected codepaths using `pnpm run test`.
 Default credentials are stored in .env.local in the repository root or inside ~/.e2b/config.json.
 
-## AgentHub
-- Central hub: `~/AgentHub/`
-- Skills: `.agents/skills/` (symlinked to AgentHub shared skills)
-- MCP: 12 servers synced across all agents
-- Agents: 14 shared agents available
-- Hooks: Safety, notification, and logging hooks
+## Quick Start
 
-## Deployment
+```bash
+# JavaScript/TypeScript
+npm i e2b          # or: pnpm add e2b
+
+# Python
+pip install e2b
+
+# Set API key
+export E2B_API_KEY=e2b_***
+```
+
+For monorepo dev:
+
+```bash
+pnpm install       # install all workspace deps
+pnpm run build     # build all packages
+pnpm run test      # run tests
+make codegen       # regenerate API client from OpenAPI spec
+```
+
+## Architecture
+
+SDK monorepo — publishes to npm (TypeScript) and PyPI (Python). No top-level Dockerfile.
 
-**Not a container target.** This repo is an SDK monorepo that publishes to npm (TypeScript packages) and PyPI (Python SDK). There is intentionally no `Dockerfile` or `ci-docker.yml` at the repo root.
+- `packages/js-sdk/` — JavaScript/TypeScript SDK (npm: `e2b`)
+- `packages/python-sdk/` — Python SDK (PyPI: `e2b`)
+- `packages/cli/` — CLI tool; `templates/` contains sandbox base images for self-hosting
+- `packages/code-interpreter/` — Code interpreter sandbox extension
 
-The release flow is:
+Release flow: Node → pnpm workspace + changesets + `release.yml@v1` → npm. Python → `pyproject.toml` + `release-python.yml@v1` → PyPI via OIDC Trusted Publishers.
 
-- Node packages: pnpm workspace + changesets + `release.yml@v1` → npm registry
-- Python SDK: `pyproject.toml` + `release-python.yml@v1` → PyPI via OIDC Trusted Publishers
-- Users who want sandbox images build their own from `packages/cli/templates/`
+## Conventions
 
+- Kebab-case package/file names
+- Conventional commits (`feat:`, `fix:`, `docs:`, `chore:`)
+- Always run format + lint + typecheck before committing (enforced via CI)
+- pnpm workspaces — do not use npm or yarn in this repo
+
+## Shared Resources
+
+| Resource | Location |
+| --- | --- |
+| Reusable CI workflows | `Ai-road-4-You/enterprise-ci-cd` |
+| Release workflow | `enterprise-ci-cd/.github/workflows/release.yml@v1` |
+| AgentHub | `~/AgentHub/` (central hub, 12 MCP servers) |
+
+## Deployment
+
+**Not a container target.** Users who want sandbox images build their own from `packages/cli/templates/`.
 Policy set 2026-04-08 (Wave 4). See `_shared/exec-logs/wave3-dockerfiles.md` for original escalation.
+
+## AgentHub
+
+- Central hub: `~/AgentHub/`
+- Skills: `.agents/skills/` (symlinked to AgentHub shared skills)
+- MCP: 12 servers synced across all agents
+- Agents: 14 shared agents available
+- Hooks: Safety, notification, and logging hooks