Tokei, a powerful and efficient command-line tool, is designed to provide detailed insights into the structure of your codebase.
Its primary function is to analyze and display statistics about your code, such as the number of files, total lines of code, comments, and blank lines, all categorized by programming language.
This makes Tokei an invaluable resource for developers seeking to understand their projects better or track progress over time.
Key Features Of Tokei
- Speed and Accuracy:
Tokei is incredibly fast, capable of processing millions of lines of code within seconds. It ensures accuracy by correctly handling multiline comments, nested comments, and ignoring comments within strings. - Extensive Language Support:
Supporting over 150 programming languages and their extensions, Tokei caters to a wide range of development environments. - Customizable Output Formats:
Tokei can output results in formats such as JSON, YAML, and CBOR. This flexibility allows developers to store or integrate the data into other tools seamlessly. - Cross-Platform Availability:
Whether you’re using macOS, Linux, or Windows, Tokei is easily installable via package managers like Homebrew, Cargo, Scoop, and others. - Library Integration:
Tokei can also be used as a library for integration into other projects, enhancing its utility beyond standalone usage. - Color Customization:
Developers can toggle between colored or monochrome output by setting theNO_COLOR
environment variable.
- Basic Analysis:
To analyze a folder and its subdirectories:
tokei ./folder
- Multiple Folders:
Analyze multiple directories in one command:
tokei ./folder1 ./folder2
- Excluding Files:
Exclude specific files or patterns using--exclude
:
tokei ./folder --exclude *.rs
- Sorting Output:
Sort results by columns likecode
,comments
, orlines
:
tokei ./folder --sort code
- Output Formats:
Export results in JSON format:
tokei ./folder --output json
Tokei is available through various package managers (e.g., cargo install tokei
for Rust users). Prebuilt binaries can also be downloaded from its GitHub releases section.
Tokei is a versatile tool that empowers developers with detailed insights into their codebase. Its speed, accuracy, and extensive features make it an essential utility for tracking code statistics across diverse projects.
Whether you’re managing a small project or a massive repository with multiple languages, Tokei simplifies the process of understanding your code’s structure and evolution.