diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..be6e462 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,22 @@ +# Understand Anything + +## Project Overview +An open-source tool combining LLM intelligence + static analysis to produce interactive dashboards for understanding codebases. + +## Architecture +- **Monorepo** with pnpm workspaces +- **packages/core** — Shared analysis engine (types, persistence, tree-sitter plugin, LLM prompt templates) +- **packages/dashboard** — React + TypeScript web dashboard (React Flow, Monaco Editor, Zustand, TailwindCSS) +- **packages/skill** — Claude Code skill (not yet implemented) + +## Key Commands +- `pnpm install` — Install all dependencies +- `pnpm --filter @understand-anything/core build` — Build the core package +- `pnpm --filter @understand-anything/core test` — Run core tests +- `pnpm dev:dashboard` — Start dashboard dev server + +## Conventions +- TypeScript strict mode everywhere +- Vitest for testing +- ESM modules (`"type": "module"`) +- Knowledge graph JSON lives in `.understand-anything/` directory of analyzed projects diff --git a/README.md b/README.md new file mode 100644 index 0000000..33ca4c1 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# Understand Anything + +An open-source tool that combines LLM intelligence with static analysis to help anyone understand any codebase — from junior developers to product managers. + +## Features + +- **Knowledge Graph** — Automatically maps your codebase into an interactive graph of files, functions, classes, and their relationships +- **Multi-Panel Dashboard** — Graph view, code viewer, chat, and learn panels in a workspace layout +- **Natural Language Search** — Search your codebase with plain English: "which parts handle authentication?" +- **Tree-sitter Analysis** — Accurate structural analysis for TypeScript, JavaScript (more languages coming) +- **LLM-Powered Summaries** — Every node gets a plain-English description of what it does and why + +## Quick Start + +```bash +# Install dependencies +pnpm install + +# Build the core package +pnpm --filter @understand-anything/core build + +# Start the dashboard dev server +pnpm dev:dashboard +``` + +## Project Structure + +``` +packages/ + core/ — Analysis engine: types, persistence, tree-sitter, LLM prompts + dashboard/ — React + TypeScript web dashboard + skill/ — Claude Code skill (coming soon) +``` + +## Tech Stack + +- TypeScript, pnpm workspaces +- React 18, Vite, TailwindCSS +- React Flow (graph visualization) +- Monaco Editor (code viewer) +- Zustand (state management) +- tree-sitter (static analysis) + +## License + +MIT