mirror of
https://github.com/samsonjs/vibetunnel.git
synced 2026-03-29 10:05:53 +00:00
1.9 KiB
1.9 KiB
Claude Development Notes
IMPORTANT: BEFORE YOU DO ANYTHING, READ spec.md IN FULL USING THE READ TOOL! IMPORTANT: NEVER USE GREP. ALWAYS USE RIPGREP!
Updating spec.md
As code changes, the spec.md might get outdated. If you detect outdated information, ask the user if they want to regenerate the spec.md file.
How to regenerate spec.md:
- Create a todo list to track the analysis tasks
- Use multiple parallel Task tool calls to analyze:
- Server architecture (src/server/, authentication, session management)
- Client architecture (src/client/, components, services)
- fwd.ts application functionality
- API endpoints and protocols
- Binary buffer format and WebSocket implementation
- HQ mode and distributed architecture
- Focus on capturing:
- File locations with key line numbers for important functions
- Component responsibilities and data flow
- Protocol specifications and message formats
- Configuration options and CLI arguments
- Write a concise spec.md that serves as a navigation map, keeping descriptions brief to minimize token usage
- Include a "Key Files Quick Reference" section for fast lookup
Build Process
- Never run build commands - the user has
npm run devrunning which handles automatic rebuilds - Changes to TypeScript files are automatically compiled and watched
- Do not run
npm run build:clientor similar build commands
Development Workflow
- Make changes to source files in
src/ - Format, lint and typecheck after you made changes
npm run formatnpm run lintnpm run lint:fixnpm run typecheck
- Always fix all linting and type checking errors, including in unrelated code
- Never run the tests, unless explicitely asked to.
npm run test
CRITICAL
- NEVER EVER USE SETTIMEOUT FOR ANYTHING IN THE FRONTEND UNLESS EXPLICITLY PERMITTED
Server Execution
- NEVER RUN THE SERVER YOURSELF, I ALWAYS RUN IT ON THE SIDE VIA NPM RUN DEV!