sketchit
v2.0.0
Published
A CLI tool to generate folder structure into structure.txt
Readme
Folder Structure Generator CLI
A simple CLI tool that scans a target directory and generates a tree-style folder structure, saving it into a structure.txt file.
Useful for:
- README documentation
- Project architecture visualization
- Developer onboarding
- Before/after refactor comparison snapshots
✨ Features
- Recursively scans folders & files
- Outputs formatted tree structure
- Saves results automatically to
structure.txt - Option to specify a custom target path
- Defaults to current working directory if no argument provided
📦 Installation & Usage
Run using NPM
npx sketchit🧠 How It Works
The CLI scans all directories recursively, formats them using ASCII connectors (├──, └──, │), and writes the visual structure map to a text file.
🎉 Use Cases
- Document directory tree in README.md
- Share architecture during reviews
- Study folder layouts of new codebases
- Snapshot of file structure during refactoring
🚀 Roadmap
- Add
--ignoreflag for excluding folders (e.g.node_modules) - Add Markdown export option (
--md) - Add JSON representation
- Convert to npm global CLI (
npx folder-tree)
🤝 Contributing
Suggestions, improvements, and PRs are welcome.
📄 License
MIT License — free for personal & commercial use.
