Tokei (時計)

A blazingly fast CLOC(Count Lines Of Code) program, written in Rust.

Canonical Source

The canonical source of this repo is hosted on GitLab. If you have a GitLab account, please make your issues, and pull requests there. However if you don't have one, please feel free to make the issue on GitHub.

Installation

Automatic

If you have cargo 0.6.0>= installed just run the cargo install command.

$ cargo install tokei

Manual

Fedora 64 bit

Install rust and cargo from either the official page or use a copr repo such as Rust

$ dnf copr enable phnxrbrn/tokei
$ dnf install tokei

Other

$ git clone https://github.com/Aaronepower/tokei.git
$ cd tokei
$ cargo build --release

Linux

# sudo mv target/release/tokei /usr/local/bin

OSX

# sudo mv target/release/tokei /usr/local/bin/tokei

Windows

Create a folder for tokei
search for env
open "edit your enviroment variables"
edit PATH
append folder path to the end of the string ie: <path_stuff_here>;C:/tokei/;

Usage

To use tokei, use must add it to your path. Then you can call tokei like so

$ tokei ./path/to/code

Options

Tokei 1.3.0
Aaron P. <theaaronepower@gmail.com>
A quick CLOC (Count Lines Of Code) tool

USAGE:
        Tokei [FLAGS] [OPTIONS] <input>... [--]

FLAGS:
    -f, --files        Will print out the files found only recommended for debugging purposes
    -h, --help         Prints help information
    -l, --languages    prints out supported languages and their extensions
    -V, --version      Prints version information

OPTIONS:
    -e, --exclude <exclude>    Will ignore all files and directories containing the word ie --exclude node_modules
    -s, --sort <sort>          Will sort based on a certain column ie --sort=files will sort by file count. [values: files total blanks code commments]

ARGS:
    input...    The input file(s)/directory(ies)

Supported Languages

If there is a language that you want added submit a pull request with the following information

Name of language
Most common file extension
The comment syntax (Does it have block comments? is it the same as C?)

ActionScript
BASH
Batch
C
C++
ColdFusion CFScript
ColdFusion
Clojure
CoffeeScript
C#
CSS
D
Dart
LISP
FORTRAN Legacy
FORTRAN Modern
Go
C Header
C++ Header
Haskell
HTML
JAI
Java
Julia
JavaScript
JSON
JSX
LESS
Lua
Objective-C
Markdown
OCaml
Objective-C++
Pascal
PHP
Perl
Python
R
Ruby
Ruby HTML
Rust
Sass
Standard ML
SQL
TeX
Swift
TOML
TypeScript
XML
YAML

Common issues

If you get errors like the following, it is mostly like due to having folders with paths that too long. For example NPM<3.0.0 node_modules generates long path files, which causes problems on windows. You can exclude these paths with theexclude argument, or in the case of NPM, update to >3.0.0, and update your codebase dependencies.

"The system cannot find the path specified.\r\n"

thread <main> has overflowed its stack
Illegal instruction: 4

Copyright and License

See CONTRIBUTORS.md 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.

tokei 1.4.1