Effortlessly Feed Your Code to AI Chatbots with CrazyNote!

Sarthak Dwivedi — Sat, 06 Jul 2024 13:31:34 +0000

Do you know how tedious it is to copy code from one file to another to give AI chatbot (or ChatGPT) some context? It's like a never-ending game of digital hopscotch! That's why I created CrazyNote, a CLI app that automates this process. It’s customizable, so it works for almost any project.

What is CrazyNote?

CrazyNote is my brainchild, designed to take the crazy out-of-context sharing processes! Imagine a tool that scans your project directory, reads file contents, and then creates comprehensive Markdown documentation. It's perfect for feeding data to AI chatbots. It's a kind of code flattener if you will but it doesn't merge everything as a single file rather creates a markdown file.

Why the name CrazyNote? Well, I was going to call it mad-structure (Which was the first iteration but then I decided to do a new iteration from scratch so there was already mad-structure folder in my drive and I felt too lazy to remove it) So it's nothing fancy.

Features

Directory Traversal: CrazyNote dives deep into your project directory, including all relevant files.
Ignore Patterns: You can exclude specific files or directories based on patterns.
Custom Templates: Use predefined or custom Handlebars templates to format your documentation.
Language Mapping: Detects the programming language of files based on their extensions.
File Metadata: Includes file size and last modified date in the documentation.
Initialization: Quickly set up default configuration files and templates.

How to Use CrazyNote

You can install CrazyNote directly from npm. It's super easy!

npm install -g crazynote

Setting Up CrazyNote in Your Project
First, initialize the configuration file:

crazynote --init

Or choose a template:

crazynote --init --template detailed_explorer

Once initialized, run CrazyNote to generate your Markdown File with your project content:

crazynote

Example

Let's use CrazyNote on CrazyNote itself. Here's the final output it generated: CrazyNote Output.

Thanks and Suggestions