Skip to content

CLI tool to merge your codebase into a single markdown file

Notifications You must be signed in to change notification settings

enzojs/codebasemd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CodeBaseMD - CLI tool to merge your codebase into a single markdown file

Effortlessly consolidate your entire codebase into a single, well-structured Markdown file with this CLI tool. Designed to make large codebases more LLM-friendly, CodeBaseMD provides a streamlined way to improve context when working with AI tools, perfect for developers leveraging AI-driven coding assistance.

Run

npm

npx codebasemd

bun

bunx codebasemd

Help

bunx codebasemd --help

Installing as dev dependency

bun add codebasemd --dev
bun run codebasemd

Development

Install the dependencies:

bun install

Build:

bun run build

Use local build:

bun run gen

bun?

Bun is a fast JavaScript all-in-one toolkit.

npm, pnpm, yarn etc?

It should work, just run the npx equivalent

npx codebasemd

What is bunx?

Use bunx to auto-install and run packages from npm. It's Bun's equivalent of npx or yarn dlx

TODO

  • Implement tests
  • Support more configuration options
  • truncate large files --truncate=<middle|top|bottom> --truncate-percent=10 will truncate 10% starting from --truncate arg only when the file exceeds --max-lines arg
  • support ignore globs in eslint and tsconfig

Contribute

https://github.com/enzojs/codebasemd

About

CLI tool to merge your codebase into a single markdown file

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published