document_it

A simple CLI tool to generate folder structure tree documentation for your projects.

Installation

Global Installation (Recommended)

npm install -g document-it-cli

Local Development

git clone <your-repo-url>
cd document-it-cli
npm install
npm run build
npm link

Usage

Navigate to any directory and run:

document_it

This will create a STRUCTURE.md file in the current directory with the folder tree.

Options

document_it [options]

Options:

• -o, --output <file> - Specify output file (default: STRUCTURE.md)
• -d, --depth <number> - Maximum depth to traverse
• -i, --ignore <patterns...> - Additional patterns to ignore
• -H, --show-hidden - Show hidden files and folders
• -p, --print - Print to console instead of file
• -h, --help - Display help
• -V, --version - Display version

Examples

Basic usage:

document_it

Custom output file:

document_it -o docs/structure.txt

Limit depth to 3 levels:

document_it -d 3

Print to console:

document_it -p

Ignore additional patterns:

document_it -i "*.log" "temp" "cache"

Show hidden files:

document_it -H

Combine options:

document_it -o PROJECT_STRUCTURE.md -d 4 -i "*.test.js"

Default Ignored Patterns

The tool automatically ignores:

• node_modules
• .git
• dist
• build
• .next
• coverage
• .DS_Store
• .env

Example Output

my-project/
├── src/
│   ├── components/
│   │   ├── Header.tsx
│   │   └── Footer.tsx
│   ├── utils/
│   │   └── helpers.ts
│   └── index.ts
├── package.json
├── tsconfig.json
└── README.md

Development

Setup

npm install

Build

npm run build

Test locally

npm link
document_it -p

Clean build files

npm run clean

Publishing to npm

1. Update version in package.json
2. Build the project:

   npm run build

3. Login to npm:

   npm login

4. Publish:

   npm publish

License

MIT

Author

Your Name

Contributing

Pull requests are welcome! Please ensure your code follows the existing style.

Issues

Report issues at: https://github.com/yourusername/document-it-cli/issues