tokei Documentation

1. Project Overview & Quickstart (XAMPPRocky/tokei) Copy Chapter

File: README.md Copy Chapter

Tokei ([時計](https://en.wiktionary.org/wiki/%E6%99%82%E8%A8%88))

)

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

Example Copy Chapter

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 Language            Files        Lines         Code     Comments       Blanks
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 BASH                    4           49           30           10            9
 JSON                    1         1332         1332            0            0
 Shell                   1           49           38            1           10
 TOML                    2           77           64            4            9
───────────────────────────────────────────────────────────────────────────────
 Markdown                5         1355            0         1074          281
 |- JSON                 1           41           41            0            0
 |- Rust                 2           53           42            6            5
 |- Shell                1           22           18            0            4
 (Total)                           1471          101         1080          290
───────────────────────────────────────────────────────────────────────────────
 Rust                   19         3416         2840          116          460
 |- Markdown            12          351            5          295           51
 (Total)                           3767         2845          411          511
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 Total                  32         6745         4410         1506          829
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

[API Documentation](https://docs.rs/tokei) Copy Chapter

Table of Contents Copy Chapter

• Features
• Installation
  • Package Managers
  • Manual
• Configuration
• How to use Tokei
• Options
• Supported Languages
• Changelog
• Common Issues
• Canonical Source
• Copyright and License

Features Copy Chapter

• Tokei is very fast, and is able to count millions of lines of code in seconds.
  Check out the 11.0.0 release
  to see how Tokei's speed compares to others.

• Tokei is accurate, Tokei correctly handles multi line comments,
  nested comments, and not counting comments that are in strings. Providing an
  accurate code statistics.

• Tokei has huge range of languages, supporting over 150 languages, and
  their various extensions.

• Tokei can output in multiple formats (CBOR, JSON, YAML)
  allowing Tokei's output to be easily stored, and reused. These can also be
  reused in tokei combining a previous run's statistics with another set.

• Tokei is available on Mac, Linux, and Windows. See installation
  instructions for how to get Tokei on your platform.

• Tokei is also a library allowing you to easily integrate it with other
  projects.

• Tokei comes with and without color. Set the env variable NO_COLOR to 1, and
  it'll be black and white.

Installation Copy Chapter

Package Managers Copy Section

Unix

# Alpine Linux (since 3.13)
apk add tokei
# Arch Linux
pacman -S tokei
# Cargo
cargo install tokei
# Conda
conda install -c conda-forge tokei
# Fedora
sudo dnf install tokei
# FreeBSD
pkg install tokei
# NetBSD
pkgin install tokei
# Nix/NixOS
nix-env -i tokei
# OpenSUSE
sudo zypper install tokei
# Void Linux
sudo xbps-install tokei

macOS

# Homebrew
brew install tokei
# MacPorts
sudo port selfupdate
sudo port install tokei

Windows

# Winget
winget install XAMPPRocky.tokei
# Scoop
scoop install tokei

Manual Copy Section

Downloading

You can download prebuilt binaries in the
releases section.

Building

You can also build and install from source (requires the latest stable Rust compiler.)

cargo install --git https://github.com/XAMPPRocky/tokei.git tokei

Configuration Copy Chapter

Tokei has a configuration file that allows you to change default behaviour.
The file can be named tokei.toml or .tokeirc. Currently tokei looks for
this file in three different places. The current directory, your home directory,
and your configuration directory.

How to use Tokei Copy Chapter

Basic usage

This is the basic way to use tokei. Which will report on the code in ./foo
and all subfolders.

$ tokei ./foo

Multiple folders

To have tokei report on multiple folders in the same call, simply add all the
folders you'd like tokei to examine.

$ tokei ./foo ./bar ./baz

Excluding folders

Tokei will respect all .gitignore and .ignore files, and you can use
the --exclude option to exclude any additional files. The --exclude flag has
the same semantics as .gitignore.

$ tokei ./foo --exclude *.rs

Paths to exclude can also be listed in a .tokeignore file, using the same
syntax as .gitignore files.

Sorting output

By default tokei sorts alphabetically by language name, however using --sort
tokei can also sort by any of the columns.

blanks, code, comments, lines

$ tokei ./foo --sort code

Outputting file statistics

By default tokei only outputs the total of the languages, and using --files
flag tokei can also output individual file statistics.

$ tokei ./foo --files

Outputting into different formats

Tokei normally outputs into a nice human readable format designed for terminals.
There is also using the --output option various other formats that are more
useful for bringing the data into another program.

Note: This version of tokei was compiled without any serialization formats, to enable serialization, reinstall
tokei with the features flag.

ALL:
  cargo install tokei --features all

  CBOR:
  cargo install tokei --features cbor

  YAML:
  cargo install tokei --features yaml

Currently supported formats

• JSON --output json
• YAML --output yaml
• CBOR --output cbor

$ tokei ./foo --output json

Reading in stored formats

Tokei can also take in the outputted formats added in the previous results to its
current run. Tokei can take either a path to a file, the format passed in as a
value to the option, or from stdin.

$ tokei ./foo --input ./stats.json

Options Copy Chapter

/* Detailed source-code truncated for AI context efficiency. */

Dockerized version Copy Chapter

Tokei is available in a small alpine-based docker image, buildable through earthly:

earthly +docker

Once built, one can run the image with:

docker run --rm -v /path/to/analyze:/src tokei .

Or, to simply analyze the current folder (linux):

docker run --rm -v $(pwd):/src tokei .

Supported Languages Copy Chapter

If there is a language that you would to add to tokei feel free to make a pull
request. Languages are defined in languages.json, and you can
read how to add and test your language in our CONTRIBUTING.md.

/* Detailed source-code truncated for AI context efficiency. */

Common issues Copy Chapter

Tokei says I have a lot of D code, but I know there is no D code! Copy Section

This is likely due to gcc generating .d files. Until the D people decide on
a different file extension, you can always exclude .d files using the
-e --exclude flag like so

$ tokei . -e *.d

Canonical Source Copy Chapter

The canonical source of this repo is hosted on
GitHub. If you have a GitHub account,
please make your issues, and pull requests there.

Related Tools Copy Chapter

• tokei-pie: Render tokei's output to
  interactive sunburst chart.

Copyright and License Copy Chapter

(C) Copyright 2015 by XAMPPRocky and contributors

See the graph for a full list of contributors.

Tokei is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENCE-APACHE, LICENCE-MIT for more information.

File: fuzz/README.md Copy Chapter

Fuzzing Tokei Copy Chapter

Tokei can be fuzzed using libFuzzer, via cargo-fuzz.

First install cargo-fuzz: cargo install cargo-fuzz.

To launch a fuzzing job: cargo +nightly fuzz run <target> - it will run until you kill it with ctrl-c.

To use multiple cores: cargo +nightly fuzz run <target> --jobs=6

To speed things up (at the expense of missing bugs that only manifest in larger files):
cargo +nightly fuzz run <target> -- -max_len=200

Available fuzz targets:

• parse_from_slice_panic - checks that all of the LanguageType instances' parse_from_slice function doesn't panic.
• parse_from_slice_total - checks that the language stats pass a basic test of reporting no more total lines than
  there are new lines in the file. At the time of writing there are low-hanging bugs here.

With the two parse_from_slice fuzz targets, it makes sense to share a common corpus directory as they have identical
input formats, e.g.: cargo +nightly fuzz run parse_from_slice_{panic,total} fuzz/corpus/common

Potential improvements:

• Build the fuzz harnesses in CI, so they don't rot.
• Do some coverage analysis to check if we're missing any code we would benefit from fuzzing (once it's
  integrated into cargo-fuzz)
• Tighten the parse_from_slice_total fuzz target to check the total lines exactly matches the number of lines in the
  file. Only once any bugs found with the current fuzzer are fixed.
• Check in a minimized corpus, and run regression over it in CI.

2. Official Technical Reference & Guides (XAMPPRocky/docs) Copy Chapter

GitHub Docs Copy Chapter

This repository contains the documentation website code and Markdown source files for docs.github.com.

GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo.

In this article:

• Contributing
• READMEs
• License

Contributing Copy Chapter

Start contributing right now: Copy Section

We accept a lot of different contributions, including some that don't require you to write a single line of code.

Click **make a contribution** from docs

As you're using the GitHub Docs, you may find something in an article that you'd like to add to, update, or change. Click on make a contribution to navigate directly to that article in the codebase, so that you can begin making your contribution.

Open an issue

If you've found a problem, you can open an issue using a template.

Solve an issue

If you have a solution to one of the open issues, you will need to fork the repository and submit a pull request using the template that is visible automatically in the pull request body. For more details about this process, please check out Getting Started with Contributing.

Join us in discussions

We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in discussions.

And that's it!

That's how you can get started easily as a member of the GitHub Documentation community. :sparkles:

If you want to know more, or you're making a more complex contribution, check out Getting Started with Contributing.

There are a few more things to know when you're getting started with this repo:

1. If you're having trouble with your GitHub account, contact Support.
2. We do not accept pull requests for translated content - see CONTRIBUTING.md for more information.

READMEs Copy Chapter

In addition to the README you're reading right now, this repo includes other READMEs that describe the purpose of each subdirectory in more detail:

• content/README.md
• content/graphql/README.md
• content/rest/README.md
• contributing/README.md
• data/README.md
• data/reusables/README.md
• data/variables/README.md
• includes/liquid-tags/README.md
• includes/README.md
• javascripts/README.md
• layouts/README.md
• lib/liquid-tags/README.md
• middleware/README.md
• script/README.md
• stylesheets/README.md
• tests/README.md

License Copy Chapter

The GitHub product documentation in the assets, content, and data folders are licensed under a CC-BY license.

All other code in this repository is licensed under a MIT license.

When using the GitHub logos, be sure to follow the GitHub logo guidelines.