CLAUDE.md Editor

The CLAUDE.md file is the most important configuration file for Claude Code. It gives Claude persistent context about your project — build commands, architecture, coding conventions, and constraints. ShellPod's dashboard includes a built-in editor so you can manage this file without opening a terminal.

What is CLAUDE.md?

CLAUDE.md is a Markdown file that lives in the root of your project (or in ~/.claude/ for global settings). When Claude Code starts in a directory, it reads the CLAUDE.md file and uses its contents as context for every conversation. Think of it as a briefing document for your AI coding partner.

A well-written CLAUDE.md dramatically improves Claude Code's output because it does not have to guess about your project's conventions, tools, or architecture.

Using the dashboard editor

From your ShellPod dashboard, click the Edit CLAUDE.md button on your session card. This opens an editor with your current CLAUDE.md content (or a blank editor if one does not exist yet).

The editor lets you:

• View and edit your CLAUDE.md content with syntax highlighting
• Save changes directly to your container's filesystem
• Start from a template if you do not have a CLAUDE.md yet

What to include in CLAUDE.md

A comprehensive CLAUDE.md typically covers these sections:

Build and dev commands

List the commands Claude Code needs to build, test, and run your project:

## Build Commands
npm run dev          # Start dev server on port 3000
npm run build        # Production build
npm run test         # Run test suite
npm run lint         # Run ESLint

Architecture overview

Describe how your project is structured so Claude Code knows where to find things:

## Architecture
Next.js 15 App Router with server components.
- src/app/ — pages and API routes
- src/components/ — React components
- src/lib/ — shared utilities and clients
- prisma/ — database schema and migrations

Key files

Point out the most important files and their purposes:

## Key Files
- src/middleware.ts — Auth middleware (Clerk)
- src/lib/db.ts — Database client singleton
- src/app/api/webhooks/stripe/route.ts — Stripe webhook handler

Coding conventions

Document patterns and conventions Claude Code should follow:

## Conventions
- Use server components by default, "use client" only when needed
- Prefer named exports over default exports
- Use Tailwind CSS for styling, no CSS modules
- Error handling: always use try/catch in API routes

Security constraints

Define things Claude Code should never do:

## Security
- Never expose API keys or secrets in client-side code
- Never run containers as root
- Always validate user input in API routes

Templates

The dashboard editor includes starter templates for common project types:

• Next.js: Covers App Router, server components, API routes, and common patterns
• Node.js API: Express/Fastify conventions, middleware patterns, database access
• Python: Virtual environments, testing with pytest, package management
• General: A minimal template you can adapt to any project

Tips for effective CLAUDE.md files

• Keep it concise: Claude Code reads this every time it starts. Long, rambling CLAUDE.md files waste context window space. Aim for clear, scannable information.
• Update it regularly: As your project evolves, update CLAUDE.md to reflect new patterns, tools, or constraints. An outdated CLAUDE.md can actually hurt more than help.
• Include what you repeat: If you find yourself telling Claude Code the same thing in every conversation ("use the existing Button component, do not create a new one"), put it in CLAUDE.md.
• Test it: After updating CLAUDE.md, start a new Claude Code session and ask it about your project. It should be able to answer based on the CLAUDE.md content.

Global vs project-level CLAUDE.md

You can have CLAUDE.md files at multiple levels:

• ~/.claude/CLAUDE.md — Global settings that apply to all projects
• /path/to/project/CLAUDE.md — Project-specific settings that override globals

Use the global file for preferences that apply everywhere (like your preferred commit message style), and project files for project-specific context.