GitHub

What is the project about?

Tokei is a program that displays statistics about your code, such as the number of files, total lines, code lines, comments, and blanks, grouped by language.

What problem does it solve?

It provides a quick and accurate way to analyze the composition of a codebase, offering insights into the amount of code, comments, and blank lines across different programming languages.

What are the features of the project?

  • Fast: Counts millions of lines of code in seconds.
  • Accurate: Correctly handles multi-line comments, nested comments, and ignores comments within strings.
  • Supports many languages: Over 150 languages and their various extensions.
  • Multiple output formats: Can output in CBOR, JSON, and YAML for easy storage and reuse.
  • Cross-platform: Available on Mac, Linux, and Windows.
  • Library: Can be integrated into other projects as a library.
  • Can be configured using tokei.toml or .tokeirc.
  • Can output badges.

What are the technologies used in the project?

  • Rust (primary programming language)

What are the benefits of the project?

  • Provides a clear overview of codebase statistics.
  • Fast and efficient analysis.
  • Accurate counting, avoiding common pitfalls.
  • Supports a wide variety of programming languages.
  • Flexible output options for integration with other tools.
  • Easy to install and use on multiple platforms.

What are the use cases of the project?

  • Getting a quick overview of a project's code size and composition.
  • Tracking code statistics over time.
  • Comparing the amount of code versus comments in a project.
  • Generating reports on codebase metrics.
  • Integrating code statistics into other tools or dashboards.
tokei screenshot