DOCSEARCHbyAlgolia
Submit Docs

Claude Code Guide

repository·main·Indexed 26 days ago

https://github.com/zebbern/claude-code-guide

A comprehensive guide for Claude Code, a command-line interface and agentic tool for interacting with Claude models. Includes instructions for installation via native installers or npm, system requirements, authentication, environment variable configuration, and management of Model Context Protocol (MCP) servers. Covers the hierarchical memory system (CLAUDE.md), modular project rules, slash commands, and CLI flags for session and tool permission management.

Tokens
403.8K
Snippets
985
Records
1.4K
Agent score
89%

What's inside Claude Code Guide

  1. Overview of React Composition Patterns

    main
    This repository provides a structured collection of React composition patterns designed to scale. The patterns focus on avoiding boolean prop proliferation by utilizing compound components, lifting state, and composing internals. The patterns are categorized by impact level: CRITICAL (foundational), HIGH (maintainability), and MEDIUM (clean code practices).

  2. Overview of Three.js Best Practices

    main

    This skill provides a comprehensive performance optimization guide for Three.js applications, covering 120+ rules across 18 categories. It is designed for developers setting up new projects, writing/reviewing Three.js code, optimizing performance, fixing memory leaks, or working with custom shaders (GLSL/TSL), WebGPU, and WebXR.

    Key Priority Categories:

    • 0. Modern Setup (FUNDAMENTAL): Import maps, renderer choice, and animation loops.
    • 1. Memory Management (CRITICAL): Disposal of geometries, materials, textures, and render targets.
    • 2. Render Loop (CRITICAL): Avoiding allocations and optimizing updates.
    • 3. Draw Call Optimization (CRITICAL): Using InstancedMesh and BatchedMesh.
    • 4-6. Geometry, Materials, & Assets (HIGH): Buffer management, texture compression, and asset optimization.

  3. Overview of R3F Best Practices Rule Sections

    main

    The R3F (React Three Fiber) best practices are organized into priority levels ranging from CRITICAL to LOW. These rules cover performance optimization, animation, component patterns, canvas setup, and specialized libraries like Drei, Rapier, and Leva.

    Priority Levels:

    • Priority 1: Performance & Re-renders (CRITICAL): Focuses on preventing unnecessary re-renders and optimizing the render loop.
    • Priority 2: useFrame & Animation (CRITICAL): Focuses on efficient frame-based updates and delta time usage.
    • Priority 3: Component Patterns (HIGH): Best practices for JSX elements, props, and component lifecycle.
    • Priority 4: Canvas & Setup (HIGH): Configuration for the <Canvas /> component, camera, and GL settings.
    • Priority 5: Drei Helpers (MEDIUM-HIGH): Optimization and usage of @react-three/drei utilities.
    • Priority 6: Loading & Suspense (MEDIUM-HIGH): Handling assets and loading states.
    • Priority 7: State Management (MEDIUM): Patterns for using Zustand and managing state in 3D scenes.
    • Priority 8: Events & Interaction (MEDIUM): Managing pointer events and raycasting.
    • Priority 9: Post-processing (MEDIUM): Using effect composers and shaders.
    • Priority 10: Physics Rapier (LOW-MEDIUM): Implementing physics simulations.
    • Priority 11: Leva Debug GUI (LOW): Using Leva for development debugging.

  5. Key mindset shifts when migrating from Selenium to Playwright

    main

    When migrating from Selenium to Playwright, consider these fundamental architectural differences:

    1. Auto-waiting: No more WebDriverWait. Actions and web-first assertions wait automatically.
    2. Protocol: Playwright uses persistent bidirectional connections (CDP, DevTools, or WebKit protocol) instead of the request-response W3C WebDriver HTTP protocol, reducing overhead.
    3. Driver Management: No need for WebDriverManager or manual driver paths; use npx playwright install to manage browser binaries.
    4. Wait Consistency: Playwright eliminates the confusion between implicit and explicit waits by using a single auto-waiting mechanism.
    5. Lazy Locators: Locators re-query the DOM on every use, preventing stale element errors.
    6. Integrated Runner: Playwright includes a built-in test runner (Playwright Test) with parallel execution, fixtures, and reporting, whereas Selenium requires an external framework (JUnit, pytest, etc.).

  6. Core principles of CV Tailor

    main

    The CV Tailor skill operates under four core principles to ensure high-quality results:

    • Authenticity first: All optimizations must be based on your real experience. The tool is strictly prohibited from fabricating data or experience.
    • Targeted optimization: Every change must serve alignment with the Job Description (JD); aimless embellishment is avoided.
    • Actionable advice: Recommendations are designed to be directly usable (e.g., instead of saying "add metrics", the tool guides you on how to do so).
    • Privacy protection: Users are reminded to redact sensitive information (phone numbers, home addresses, etc.) before sharing their resume.

  7. Supported Use Cases for Dev Guide Generator

    main

    The dev-guide-generator is designed to create several types of technical documentation:

    • Tool usage: Tutorials for tools like Git, Docker, Kubernetes, Vim, etc.
    • Environment setup: Development environments, CI/CD pipelines, server configuration, etc.
    • Programming introductions: Language primers, framework quickstarts, library usage, etc.
    • Operations manuals: Deployment, monitoring, logging, backup and recovery, etc.
    • Data processing: Database operations, ETL workflows, data analysis tool usage, etc.

  8. Explore SQLite and PostgreSQL databases with database-scout

    main
    database-scout is a read-only exploration tool for SQLite and PostgreSQL databases. It allows you to list tables, inspect schemas, preview data, generate Mermaid ER diagrams, and run safe, read-only SQL queries. It is designed with security in mind, using connection-level read-only modes and a strict SQL whitelist to prevent write operations and injection attacks.

  9. Use the code-documenter skill

    main
    The code-documenter skill is a specialist role designed for technical writing tasks including adding docstrings, creating API specifications (OpenAPI/Swagger), building documentation sites (Docusaurus, MkDocs, VitePress), and writing developer guides or tutorials. It is suitable for documenting various protocols such as REST, GraphQL, WebSocket, and gRPC.

  10. Understand code-vuln-audit scan modules

    main

    The tool provides three distinct scanning capabilities:

    1. Dependency Vulnerability Scanning (deps)

    Automatically detects the project type and uses the appropriate tool:

    • Node.js: Detects package.json and package-lock.json, then runs npm audit.
    • Python: Detects requirements.txt, pyproject.toml, or Pipfile, then runs pip-audit.

    2. Secret Leak Detection (secrets)

    Uses two methods to find hardcoded credentials:

    • Regex Matching: Targets common patterns like AWS Access Keys (AKIA...), GitHub Tokens (ghp_...), Slack Tokens (xoxb-...), Stripe Keys (sk_live_...), Private Keys, and JWTs.
    • Shannon Entropy Analysis: Identifies high-entropy string constants (threshold > 4.5 and length >= 20) to find non-standard secrets.

    3. OWASP Pattern Detection (owasp)

    Identifies statically detectable patterns from the OWASP Top 10, including:

    • Injection: SQL injection, command injection (os.system, eval, etc.), and XSS (innerHTML, dangerouslySetInnerHTML).
    • Cryptographic Failures: Weak hashes (MD5/SHA1) or ciphers (DES/RC4).
    • Insecure Deserialization: Use of pickle, yaml.load, marshal, or unserialize.
    • Other: Path traversal, SSRF, and security misconfigurations (e.g., CORS wildcards).

  11. Use the Next.js Developer skill

    main
    Invoke the nextjs-developer skill when building Next.js 14+ applications. This skill is specialized for the App Router architecture, React Server Components (RSC), and server actions. It is intended for full-stack feature implementation, performance optimization, SEO implementation, and production deployment (e.g., Vercel).

  12. Use the pipeline-blueprint skill for CI/CD setup

    main
    The pipeline-blueprint skill provides CI/CD pipeline templates and best practices specifically for GitHub Actions and GitLab CI. It is designed to recommend configurations based on your project type (e.g., frontend, backend, library, monorepo, or mobile) and your specific stack (language, framework, and deployment target).