https://github.com/agoldian/claudenv
Automated project documentation generator for Claude Code and AI coding agents. Scans any tech stack, asks clarifying questions, generates CLAUDE.md + memory files + validation hooks. Dual-mode: slash commands inside Claude Code + standalone npm CLI.
https://github.com/agoldian/claudenv
ai-agents antropic claude claude-code devtools
Last synced: about 22 hours ago
JSON representation
Automated project documentation generator for Claude Code and AI coding agents. Scans any tech stack, asks clarifying questions, generates CLAUDE.md + memory files + validation hooks. Dual-mode: slash commands inside Claude Code + standalone npm CLI.
- Host: GitHub
- URL: https://github.com/agoldian/claudenv
- Owner: AGoldian
- License: mit
- Created: 2026-02-16T15:24:55.000Z (3 days ago)
- Default Branch: main
- Last Pushed: 2026-02-17T21:37:19.000Z (2 days ago)
- Last Synced: 2026-02-18T00:38:38.625Z (2 days ago)
- Topics: ai-agents, antropic, claude, claude-code, devtools
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/claudenv
- Size: 90.8 KB
- Stars: 5
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# claudenv
One command to set up [Claude Code](https://docs.anthropic.com/en/docs/claude-code) in any project. Claude AI analyzes your codebase and generates all the documentation it needs to work effectively.
## Quick Start
```bash
npm i -g claudenv && claudenv
```
Done. Open Claude Code in any project and type `/claudenv`.
## How It Works
**One-time setup** — install and activate:
```bash
npm i -g claudenv && claudenv
```
This installs the `/claudenv` command globally into `~/.claude/`, making it available in every project.
**In any project** — open Claude Code and type `/claudenv`.
Claude AI will:
1. Read your manifest files, configs, and source code
2. Detect your tech stack, frameworks, and tooling
3. Ask you about the project (description, deployment, conventions)
4. Generate all documentation files
5. Search the [MCP Registry](https://registry.modelcontextprotocol.io) and configure MCP servers
6. Install slash commands for ongoing maintenance
You now have four commands available in Claude Code:
| Command | What it does |
|---------|-------------|
| `/init-docs` | Regenerate documentation from scratch |
| `/update-docs` | Scan for changes and propose updates |
| `/validate-docs` | Check that documentation is complete and correct |
| `/setup-mcp` | Recommend and configure MCP servers |
## What Gets Generated
```
your-project/
├── CLAUDE.md # Project overview, commands, architecture
├── _state.md # Session memory (decisions, focus, issues)
├── .mcp.json # MCP server configuration
└── .claude/
├── rules/
│ ├── code-style.md # Coding conventions (scoped by file paths)
│ ├── testing.md # Test patterns and commands
│ └── workflow.md # Claude Code best practices
├── settings.json # Validation hooks
├── commands/
│ ├── init-docs.md # /init-docs
│ ├── update-docs.md # /update-docs
│ ├── validate-docs.md # /validate-docs
│ └── setup-mcp.md # /setup-mcp
├── skills/
│ └── doc-generator/ # Auto-triggers when docs need updating
└── agents/
└── doc-analyzer.md # Read-only analysis subagent
```
### Key Files
| File | Purpose |
|------|---------|
| `CLAUDE.md` | Compact project overview with `@import` references to rule files |
| `_state.md` | Persists context between sessions — current focus, decisions, known issues |
| `.claude/rules/workflow.md` | Best practices: plan mode, `/compact`, subagents, git discipline |
| `.claude/rules/code-style.md` | Language and framework-specific coding conventions |
| `.claude/rules/testing.md` | Test framework patterns and commands |
| `.mcp.json` | MCP server configuration with `${ENV_VAR}` placeholders |
## MCP Server Recommendations
`/claudenv` automatically recommends MCP servers based on your tech stack. You can also run `/setup-mcp` independently at any time.
**How it works:**
1. Claude analyzes your project's dependencies, databases, cloud services, and tools
2. Searches the [official MCP Registry](https://registry.modelcontextprotocol.io) for matching servers
3. Verifies trust via npm download counts (filters out servers with <100 monthly downloads)
4. Presents recommendations grouped as **Essential** / **Recommended** / **Optional**
5. Generates `.mcp.json` with selected servers
**Example output** (`.mcp.json`):
```json
{
"mcpServers": {
"context7": {
"command": "npx",
"args": ["-y", "@upstash/context7-mcp@latest"],
"env": {}
},
"postgres": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-postgres@latest", "${POSTGRES_CONNECTION_STRING}"],
"env": {}
}
}
}
```
Secrets use `${ENV_VAR}` placeholders — configure them with:
```bash
claude config set env.POSTGRES_CONNECTION_STRING "postgresql://..."
```
`.mcp.json` is safe to commit — it never contains actual secrets.
Run `/setup-mcp --force` to auto-select Essential + Recommended servers without prompting.
## Tech Stack Detection
Claude AI reads your actual code, but the following are auto-detected for context:
- **Languages**: TypeScript, JavaScript, Python, Go, Rust, Ruby, PHP, Java, Kotlin, C#
- **Frameworks**: Next.js, Vite, Nuxt, SvelteKit, Astro, Angular, Django, FastAPI, Flask, Rails, Laravel, Spring Boot, and more
- **Package managers**: npm, yarn, pnpm, bun, poetry, pipenv, uv, cargo, go modules
- **Test frameworks**: Vitest, Jest, Playwright, Cypress, pytest, RSpec, go test, cargo test
- **CI/CD**: GitHub Actions, GitLab CI, Jenkins, CircleCI
- **Linters/formatters**: ESLint, Biome, Prettier, Ruff, RuboCop, golangci-lint, Clippy
## CLI Reference
```
claudenv Install /claudenv into ~/.claude/ (default)
claudenv install Same as above (explicit)
claudenv install -f Reinstall, overwriting existing files
claudenv uninstall Remove /claudenv from ~/.claude/
claudenv init [dir] Legacy: static analysis + terminal prompts (no AI)
claudenv init -y Legacy: skip prompts, auto-detect everything
claudenv generate Templates only, no scaffold
claudenv validate Check documentation completeness
```
## Alternative: Run Without Installing
```bash
npx claudenv # npm
pnpm dlx claudenv # pnpm
bunx claudenv # bun
```
## Uninstall
```bash
claudenv uninstall # Remove from ~/.claude/
npm uninstall -g claudenv
```
## Requirements
- Node.js >= 20
- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) CLI
## License
MIT