Treekei is a command-line interface tool that combines a file tree display with line counts, providing a swift way to understand code distribution in a project. Unlike existing tools, Treekei allows users to visualize both structure and content, enhancing the experience of exploring codebases efficiently.
Treekei is an innovative command-line interface (CLI) tool designed to provide a comprehensive view of file structures alongside line counts within projects. By combining the functionalities of traditional directory listing tools like tree and line counting utilities like tokei, Treekei offers a unique ability to visualize code distribution effectively.
Key Features:
- Combined View: Unlike existing tools, Treekei delivers a combined output that displays both the file structure and the respective line counts for each file, allowing for a quick understanding of code distribution at a glance.
| Tool | Tree | Line Count | Combined View |
|---|---|---|---|
| tree | ✅ | ❌ | ❌ |
| tokei | ❌ | ✅ | ❌ |
| treekei | ✅ | ✅ | ✅ |
This powerful tool streamlines project exploration, making it easier to assess the volume of code across different languages and directories.
Usage Example:
To get started, run the following command in the terminal:
treekei
Custom Options:
Treekei includes a variety of options to tailor the output based on user needs:
--all: Includes hidden files in the output.--dir-only: Displays only directories.--lang string: Focuses the line count on a specified programming language.--level int: Sets the maximum depth of the file tree.--sort string: Determines the sorting method for the output, which defaults to sorting by lines of code but can be switched to alphabetical order.
Compatibility:
Currently optimized for macOS (Apple Silicon), Treekei is anticipated to function on any Unix-like operating system, though Windows support is not yet available. Users on non-macOS platforms can build from source to utilize Treekei.
Conclusion:
Designed for developers who want a quick and efficient way to visualize their code files, Treekei simplifies the assessment process, greatly enhancing productivity and project management.
No comments yet.
Sign in to be the first to comment.