Skip to content

Repository files navigation

Claude Init

PyPI version Python Version License: MIT

Claude Init is a one-click tool for configuring Claude projects with support for multiple project types and custom configurations. It automatically detects your project type and generates appropriate configuration files for seamless integration with Claude Code.

Features

  • Smart Detection: Automatically detects project type (Python, JavaScript, TypeScript, Rust, Go, Java, etc.)
  • Interactive Setup: User-friendly CLI with interactive configuration options
  • CLAUDE.md Generation: Creates comprehensive Claude configuration documentation
  • IDE Integration: Generates VS Code settings and tasks optimized for Claude
  • Code Style Setup: Configures formatters and linters (Black, Prettier, ESLint, etc.)
  • Pre-commit Hooks: Optional pre-commit configuration for code quality
  • Customizable: Flexible configuration options for different project needs

Installation

pip install claude-init

Quick Start

Navigate to your project directory and run:

claude-init

The tool will:

  1. Detect your project type automatically
  2. Guide you through an interactive setup
  3. Generate appropriate configuration files
  4. Set up development tools and VS Code integration

Usage Examples

Basic Usage

# Setup Claude config in current directory
claude-init

# Setup Claude config in specific directory
claude-init /path/to/project

# Force specific project type
claude-init --type python

# Preview changes without applying
claude-init --dry-run

# Use default settings without prompting
claude-init --non-interactive

Project Type Support

Claude Init supports the following project types:

  • Python - Detects requirements.txt, pyproject.toml, setup.py
  • JavaScript - Detects package.json, .js files
  • TypeScript - Detects tsconfig.json, .ts/.tsx files
  • Rust - Detects Cargo.toml, .rs files
  • Go - Detects go.mod, .go files
  • Java - Detects pom.xml, build.gradle, .java files
  • Generic - Fallback for other project types

Generated Files

Claude Init can generate the following files based on your configuration:

Core Files

  • CLAUDE.md - Comprehensive project documentation for Claude
  • .vscode/settings.json - VS Code settings optimized for Claude
  • .vscode/tasks.json - Development tasks and commands
  • .gitignore updates - Claude-specific ignore patterns

Code Style (Optional)

  • pyproject.toml - Black/Ruff configuration for Python
  • .prettierrc - Prettier configuration for JavaScript/TypeScript
  • .eslintrc.json - ESLint configuration
  • ruff.toml - Ruff configuration for Python

Development Tools (Optional)

  • .pre-commit-config.yaml - Pre-commit hooks configuration

Configuration Options

During interactive setup, you'll be prompted for:

  • Project Type: Detected automatically or manually selected
  • CLAUDE.md Creation: Generate comprehensive Claude documentation
  • VS Code Settings: Create IDE-specific configuration
  • Gitignore Rules: Add Claude-specific ignore patterns
  • Pre-commit Hooks: Setup automated code quality checks
  • Code Style: Configure formatters and linters
  • Examples: Include example configurations and templates

CLAUDE.md Template

The generated CLAUDE.md file includes:

  • Project overview and structure
  • Development commands and workflows
  • Code style guidelines
  • Testing instructions
  • Build and deployment procedures
  • Claude-specific development notes

Example structure:

# Project Name

## Project Overview
- Project type and description
- Generated configuration details

## Development Commands
- Install dependencies
- Run tests
- Format/lint code
- Build project

## Claude Configuration
- Code style guidelines
- Testing instructions
- Development best practices

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the GPLv3 License - see the LICENSE file for details.

Support

If you encounter any issues or have questions:

  1. Check the GitHub Issues
  2. Create a new issue with detailed information about your problem
  3. Include your project type, operating system, and Python version

Community Templates

Claude Init includes a growing collection of community-contributed templates and configurations. These templates have been contributed by developers worldwide and cover various project types, frameworks, and development workflows.

How to Contribute Templates

We welcome community contributions! To add your Claude configuration template:

  1. Create a GitHub issue with your template URL
  2. Include template metadata: author, license, description, supported project types
  3. Our maintainers will review and integrate your template

Template Categories

  • Official - Templates maintained by the Claude Init team
  • Community - User-contributed templates from the community
  • Claude MD - Complete CLAUDE.md file templates
  • Commands - Reusable command and script templates
  • Examples - Example configurations and best practices

Commands

Add to Changelog Command

Claude Reflection and Optimization Command

  • Author: a-c-m
  • License: Unknown
  • Project Types: generic
  • Description: Advanced prompt engineering command for analyzing and optimizing Claude Code instructions through systematic review of chat history, configuration, and performance patterns
  • Source: https://gist.github.com/a-c-m/f4cead5ca125d2eaad073dfd71efbcfc#file-reflection-md
  • Tags: prompt-engineering, optimization, analysis, meta-improvement, reflection, performance, instruction-tuning

Analyze Codebase Readiness Command

  • Author: kingler
  • License: Unknown
  • Project Types: generic, javascript, typescript, python
  • Description: Comprehensive project analysis command that assesses codebase readiness, deployment status, feature completion percentages, and generates detailed project status reports with structured documentation output
  • Source: https://github.com/kingler/n8n_agent/blob/main/.claude/commands/analyze_codebase.md
  • Tags: analysis, project-assessment, deployment-readiness, feature-tracking, code-quality, testing, documentation, status-reports

Project Todo Manager Command

  • Author: chrisleyva
  • License: Unknown
  • Project Types: generic
  • Description: Intelligent todo management system for Claude Code that maintains todos.md files with automatic due date handling, priority sorting, and comprehensive task lifecycle management
  • Source: https://github.com/chrisleyva/todo-slash-command/blob/main/todo.md
  • Tags: todo, task-management, project-organization, markdown, due-dates, productivity, automation

Add Template Command

  • Author: claude-init
  • License: MIT
  • Project Types: generic
  • Description: Claude command for adding community templates to Claude Init collection with automatic analysis, categorization, and metadata extraction from source URLs
  • Source: https://github.com/liuhangbin/claude-init
  • Tags: template-management, automation, community, analysis, metadata, categorization, collection

Claude Md

Python Development Guidelines CLAUDE.md

  • Author: ArthurClune
  • License: Unknown
  • Project Types: python
  • Description: Comprehensive Python development guidelines for Claude Code featuring modern tooling with uv package manager, strict code quality standards, Ruff formatting, and systematic development practices
  • Source: https://github.com/ArthurClune/claude-md-examples/blob/main/python-CLAUDE.md
  • Tags: python, uv, ruff, pyright, type-checking, pre-commit, development-guidelines, code-quality, testing

SteadyStart Project Claude Guide

  • Author: steadycursor
  • License: Unknown
  • Project Types: typescript, javascript, react
  • Description: Comprehensive Claude interaction guide for TypeScript/React projects with strict architectural patterns, communication protocols, knowledge persistence strategies, and detailed code style enforcement
  • Source: https://github.com/steadycursor/steadystart/blob/main/CLAUDE.md
  • Tags: typescript, react, architecture, communication-protocols, code-style, tailwind, luxon, knowledge-persistence, commands

Go TPL Developer Guide CLAUDE.md

  • Author: KarpelesLab
  • License: Unknown
  • Project Types: go
  • Description: Modern Go development guidelines for Claude Code featuring Go 1.23+ standards, table-driven testing, structured error handling, generics, and contemporary Go best practices
  • Source: https://github.com/KarpelesLab/tpl/blob/master/CLAUDE.md
  • Tags: go, golang, testing, error-handling, generics, goimports, makefile, modernization, best-practices

Frontend Development Guidelines CLAUDE.md

  • Author: claude-init
  • License: MIT
  • Project Types: javascript, typescript, html, css, frontend
  • Description: Comprehensive frontend development guidelines for HTML, CSS, and JavaScript projects featuring modern tooling, responsive design principles, accessibility best practices, performance optimization, and contemporary web development workflows
  • Source: https://github.com/liuhangbin/claude-init
  • Tags: html, css, javascript, typescript, frontend, responsive-design, accessibility, performance, testing, build-tools, webpack, vite

Rust Development Guidelines CLAUDE.md

  • Author: claude-init
  • License: MIT
  • Project Types: rust
  • Description: Comprehensive Rust development guidelines featuring ownership patterns, lifetimes, trait implementations, async/await programming, safe concurrency, zero-cost abstractions, and modern systems programming practices
  • Source: https://github.com/liuhangbin/claude-init
  • Tags: rust, ownership, borrowing, traits, async, concurrency, memory-safety, performance, systems-programming, cargo

Important References

Claude Code Documentation

Configuration and Setup

Advanced Features

Enterprise and Security

Community Resources

Related Tools and Frameworks

Acknowledgments

  • Built for seamless integration with Claude Code
  • Inspired by modern development tool configuration practices
  • Thanks to all contributors and users providing feedback
  • Special thanks to the community for contributing templates and configurations

About

A one-click tool for configuring Claude projects

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages