Zhankai

Writes the content of all files of a given repo.

Installation

You can install Zhankai globally using npm:

npm install -g zhankai

Or using yarn:

yarn global add zhankai

Use

Verify Installation

After installation, you can verify that Zhankai is installed correctly by checking its version:

zhankai --version

Run

To use Zhankai, navigate to the root of your repository and run:

zhankai

This will create a <REPOSITORY_NAME>_app_description.md file at the root of your repository, containing the content of all files and the repository structure.

Options

• -o, --output <filename>: Specify a custom output filename
• -d, --depth <number>: Set the maximum depth to traverse (default: Infinity)
• -c, --contents: Include file contents (default: false)

Example:

zhankai -o custom_output.md -d 2

Features

• Generates a markdown file with the content of all files in the repository
• Excludes files and directories specified in .gitignore
• Truncates files with more than 500 lines, showing only the first 30 lines
• Replaces image file contents (png, jpg, jpeg, ico) with a placeholder message
• Generates a tree structure of the repository

Contrib

Install Dependencies

pnpm i

Build and Run Locally

pnpm build
npm install -g .
zhankai

Versions

• pnpm v8.7.5
• node v20.9.0

Support

You can contact me via Element, Farcaster, Telegram, Twitter, Discord, or LinkedIn.

License

This project is licensed under the GPL-3.0 License.