ratanon/claude-code

1[2  {3    "chunk_id": 1,4    "text": "Anthropic home page English Search... Search... Navigation Getting started Common workflows Welcome Developer Guide API Guide Claude Code Model Context Protocol (MCP) Resources Release Notes Documentation Developer Discord Support Getting started Overview Set up Quickstart Memory management Common workflows Build with Claude Add Claude Code to your IDE Model Context Protocol (MCP) GitHub Actions Claude Code SDK Troubleshooting Deployment Overview Amazon Bedrock Google Vertex AI Corporate proxy LLM gateway Development containers Administration Identity and Access Management Security Monitoring Costs Reference CLI reference Interactive mode Slash commands Settings Resources Data usage Legal and compliance Each task in this document includes clear instructions, example commands, and best practices to help you get the most from Claude Code.  Understand new codebases  Get a quick codebase overview Suppose youve just joined a new project and need to understand its structure quickly. 1 Navigate to the project root directory cd /path/to/project 2 Start Claude Code claude 3 Ask for a high-level overview > give me an overview of this codebase 4 Dive deeper into specific components > explain the main architecture patterns used here > what are the key data models? > how is authentication handled? Tips: Start with broad questions, then narrow down to specific areas Ask about coding conventions and patterns used in the project Request a glossary of project-specific terms  Find relevant code Suppose you need to locate code related to a specific feature or functionality. 1 Ask Claude to find relevant files > find the files that handle user authentication 2 Get context on how components interact > how do these authentication files work together? 3 Understand the execution flow > trace the login process from front-end to database Tips: Be specific about what youre looking for Use domain language from the project  Fix bugs efficiently Suppose youve encountered an error message and need to find and fix its source. 1 Share the error with Claude > I'm seeing an error when I run npm test 2 Ask for fix recommendations > suggest a few ways to fix the @ts-ignore in user.ts 3 Apply the fix > update user.ts to add the null check you suggested Tips: Tell Claude the command to reproduce the issue and get a stack trace Mention any steps to reproduce the error Let Claude know if the error is intermittent or consistent  Refactor code Suppose you need to update old code to use modern patterns and practices. 1 Identify legacy code for refactoring > find deprecated API usage in our codebase 2 Get refactoring recommendations > suggest how to refactor utils.js to use modern JavaScript features 3 Apply the changes safely > refactor utils.js to use ES2024 features while maintaining the same behavior 4 Verify the refactoring > run tests for the refactored code Tips: Ask Claude to explain the benefits of the modern approach Request that changes maintain backward compatibility when needed Do refactoring in small, testable increments  Work with tests Suppose you need to add tests for uncovered code. 1 Identify untested code > find functions in NotificationsService.swift that are not covered by tests 2 Generate test scaffolding > add tests for the notification service 3 Add meaningful test cases > add test cases for edge conditions in the notification service 4 Run and verify tests > run the new tests and fix any failures Tips: Ask for tests that cover edge cases and error conditions Request both unit and integration tests when appropriate Have Claude explain the testing strategy  Create pull requests Suppose you need to create a well-documented pull request for your changes. 1 Summarize your changes > summarize the changes I've made to the authentication module 2 Generate a PR with Claude > create a pr 3 Review and refine > enhance the PR description with more context about the security improvements 4 Add testing details > add information about how these changes were tested Tips: Ask Claude directly to make a PR for you Review Claudes generated PR before submitting Ask Claude to highlight potential risks or considerations  Handle documentation Suppose you need to add or update documentation for your code. 1 Identify undocumented code > find functions without proper JSDoc comments in the auth module 2 Generate documentation > add JSDoc comments to the undocumented functions in auth.js 3 Review and enhance > improve the generated documentation with more context and examples 4 Verify documentation > check if the documentation follows our project standards Tips: Specify the documentation style you want (JSDoc, docstrings, etc.) Ask for examples in the documentation Request documentation for public APIs, interfaces, and complex logic  Work with images Suppose you need to work with images in your codebase, and you want Claudes help analyzing image content. 1 Add an image to the conversation You can use any of these methods: Drag and drop an image into the Claude Code window Copy an image and paste it into the CLI with ctrl+v (Do not use cmd+v) Provide an image path to Claude. E.g., Analyze this image: /path/to/your/image.png 2 Ask Claude to analyze the image > What does this image show? > Describe the UI elements in this screenshot > Are there any problematic elements in this diagram? 3 Use images for context > Here's a screenshot of the error. What's causing it? > This is our current database schema. How should we modify it for the new feature? 4 Get code suggestions from visual content > Generate CSS to match this design mockup > What HTML structure would recreate this component? Tips: Use images when text descriptions would be unclear or cumbersome Include screenshots of errors, UI designs, or diagrams for better context You can work with multiple images in a conversation Image analysis works with diagrams, screenshots, mockups, and more  Reference files and directories Use @ to quickly include files or directories without waiting for Claude to read them. 1 Reference a single file > Explain the logic in @src/utils/auth.js This includes the full content of the file in the conversation. 2 Reference a directory > What's the structure of @src/components? This provides a directory listing with file information. 3 Reference MCP resources > Show me the data from @github:repos/owner/repo/issues This fetches data from connected MCP servers using the format @server:resource. See MCP resources for details. Tips: File paths can be relative or absolute @ file references add CLAUDE.md in the files directory and parent directories to context Directory references show file listings, not contents You can reference multiple files in a single message (e.g., @file1.js and @file2.js)  Use extended thinking Suppose youre working on complex architectural decisions, challenging bugs, or planning multi-step implementations that require deep reasoning. 1 Provide context and ask Claude to think > I need to implement a new authentication system using OAuth2 for our API. Think deeply about the best approach for implementing this in our codebase. Claude will gather relevant information from your codebase and use extended thinking, which will be visible in the interface. 2 Refine the thinking with follow-up prompts > think about potential security vulnerabilities in this approach > think harder about edge cases we should handle Tips to get the most value out of extended thinking: Extended thinking is most valuable for complex tasks such as: Planning complex architectural changes Debugging intricate issues Creating implementation plans for new features Understanding complex codebases Evaluating tradeoffs between different approaches The way you prompt for thinking results in varying levels of thinking depth: think triggers basic extended thinking intensifying phrases such as think more, think a lot, think harder, or think longer triggers deeper thinking For more extended thinking prompting tips, see Extended thinking tips . Claude will display its thinking process as italic gray text above the response.  Resume previous conversations Suppose youve been working on a task with Claude Code and need to continue where you left off in a later session. Claude Code provides two options for resuming previous conversations: --continue to automatically continue the most recent conversation --resume to display a conversation picker 1 Continue the most recent conversation claude --continue This immediately resumes your most recent conversation without any prompts. 2 Continue in non-interactive mode claude --continue --print \"Continue with my task\" Use --print with --continue to resume the most recent conversation in non-interactive mode, perfect for scripts or automation. 3 Show conversation picker claude --resume This displays an interactive conversation selector showing: Conversation start time Initial prompt or conversation summary Message count Use arrow keys to navigate and press Enter to select a conversation. Tips: Conversation history is stored locally on your machine Use --continue for quick access to your most recent conversation Use --resume when you need to select a specific past conversation When resuming, youll see the entire conversation history before continuing The resumed conversation starts with the same model and configuration as the original How it works: Conversation Storage : All conversations are automatically saved locally with their full message history Message Deserialization : When resuming, the entire message history is restored to maintain context Tool State : Tool usage and results from the previous conversation are preserved Context Restoration : The conversation resumes with all previous context intact Examples: claude --continue claude --continue --print \"Show me our progress\" claude --resume claude --continue --print \"Run the tests again\"  Run parallel Claude Code sessions with Git worktrees Suppose you need to work on multiple tasks simultaneously with complete code isolation between Claude Code instances. 1 Understand Git worktrees Git worktrees allow you to check out multiple branches from the same repository into separate directories. Each worktree has its own working directory with isolated files, while sharing the same Git history. Learn more in the official Git worktree documentation . 2 Create a new worktree git worktree add .. /project-feature-a -b feature-a git worktree add .. /project-bugfix bugfix-123 This creates a new directory with a separate working copy of your repository. 3 Run Claude Code in each worktree cd .. /project-feature-a claude 4 Run Claude in another worktree cd .. /project-bugfix claude 5 Manage your worktrees git worktree list git worktree remove .. /project-feature-a Tips: Each worktree has its own independent file state, making it perfect for parallel Claude Code sessions Changes made in one worktree wont affect others, preventing Claude instances from interfering with each other All worktrees share the same Git history and remote connections For long-running tasks, you can have Claude working in one worktree while you continue development in another Use descriptive directory names to easily identify which task each worktree is for Remember to initialize your development environment in each new worktree according to your projects setup. Depending on your stack, this might include: JavaScript projects: Running dependency installation ( npm install , yarn ) Python projects: Setting up virtual environments or installing with package managers Other languages: Following your projects standard setup process  Use Claude as a unix-style utility  Add Claude to your verification process Suppose you want to use Claude Code as a linter or code reviewer. Add Claude to your build script: { ... \"scripts\" : { ... \"lint:claude\" : \"claude -p 'you are a linter. please look at the changes vs. main and report any issues related to typos. report the filename and line number on one line, and a description of the issue on the second line. do not return any other text.'\" } } Tips: Use Claude for automated code review in your CI/CD pipeline Customize the prompt to check for specific issues relevant to your project Consider creating multiple scripts for different types of verification  Pipe in, pipe out Suppose you want to pipe data into Claude, and get back data in a structured format. Pipe data through Claude: cat build-error.txt | claude -p 'concisely explain the root cause of this build error' > output.txt Tips: Use pipes to integrate Claude into existing shell scripts Combine with other Unix tools for powerful workflows Consider using output-format for structured output  Control output format Suppose you need Claudes output in a specific format, especially when integrating Claude Code into scripts or other tools. 1 Use text format (default) cat data.txt | claude -p 'summarize this data' --output-format text > summary.txt This outputs just Claudes plain text response (default behavior). 2 Use JSON format cat code.py | claude -p 'analyze this code for bugs' --output-format json > analysis.json This outputs a JSON array of messages with metadata including cost and duration. 3 Use streaming JSON format cat log.txt | claude -p 'parse this log file for errors' --output-format stream-json This outputs a series of JSON objects in real-time as Claude processes the request. Each message is a valid JSON object, but the entire output is not valid JSON if concatenated. Tips: Use --output-format text for simple integrations where you just need Claudes response Use --output-format json when you need the full conversation log Use --output-format stream-json for real-time output of each conversation turn  Create custom slash commands Claude Code supports custom slash commands that you can create to quickly execute specific prompts or tasks. For more details, see the Slash commands reference page.  Create project-specific commands Suppose you want to create reusable slash commands for your project that all team members can use. 1 Create a commands directory in your project mkdir -p .claude/commands 2 Create a Markdown file for each command echo \"Analyze the performance of this code and suggest three specific optimizations:\" > .claude/commands/optimize.md 3 Use your custom command in Claude Code > /project:optimize Tips: Command names are derived from the filename (e.g., optimize.md becomes /project:optimize ) You can organize commands in subdirectories (e.g., .claude/commands/frontend/component.md becomes /project:frontend:component ) Project commands are available to everyone who clones the repository The Markdown file content becomes the prompt sent to Claude when the command is invoked  Add command arguments with $ARGUMENTS Suppose you want to create flexible slash commands that can accept additional input from users. 1 Create a command file with the $ARGUMENTS placeholder echo \"Find and fix issue Understand the issue described in the ticket 2 . Locate the relevant code in our codebase 3 . Implement a solution that addresses the root cause 4 . Add appropriate tests 5 . Prepare a concise PR description\" > .claude/commands/fix-issue.md 2 Use the command with an issue number In your Claude session, use the command with arguments. > /project:fix-issue 123 This will replace $ARGUMENTS with 123 in the prompt. Tips: The $ARGUMENTS placeholder is replaced with any text that follows the command You can position $ARGUMENTS anywhere in your command template Other useful applications: generating test cases for specific functions, creating documentation for components, reviewing code in particular files, or translating content to specified languages  Create personal slash commands Suppose you want to create personal slash commands that work across all your projects. 1 Create a commands directory in your home folder mkdir -p ~/.claude/commands 2 Create a Markdown file for each command echo \"Review this code for security vulnerabilities, focusing on:\" > ~/.claude/commands/security-review.md 3 Use your personal custom command > /user:security-review Tips: Personal commands are prefixed with /user: instead of /project: Personal commands are only available to you and not shared with your team Personal commands work across all your projects You can use these for consistent workflows across different codebases  Next steps Claude Code reference implementation Clone our development container reference implementation. Was this page helpful? Yes No Memory management Add Claude Code to your IDE On this page Understand new codebases Get a quick codebase overview Find relevant code Fix bugs efficiently Refactor code Work with tests Create pull requests Handle documentation Work with images Reference files and directories Use extended thinking Resume previous conversations Run parallel Claude Code sessions with Git worktrees Use Claude as a unix-style utility Add Claude to your verification process Pipe in, pipe out Control output format Create custom slash commands Create project-specific commands Add command arguments with $ARGUMENTS Create personal slash commands Next steps",5    "title": "Common workflows - Anthropic",6    "url": "https://docs.anthropic.com/en/docs/claude-code/common-workflows",7    "word_count": 2640,8    "char_count": 171209  }10]