tokei_rs

KO | EN

gitlite — search

#react #ai #go #golang #machine-learning #linux #macos #nodejs #java #cli #vue #pytorch #openai #open-source

(★ 67)

The tokei.rs server code.

tokei_rs Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# tokei.rs badge service

## Scheme

tokei.rs has support for badges. For example
[![total lines](https://tokei.rs/b1/github/XAMPPRocky/tokei_rs)](https://github.com/XAMPPRocky/tokei_rs).

```sh
[![](https://tokei.rs/b1/github/XAMPPRocky/tokei_rs)](https://github.com/XAMPPRocky/tokei_rs).
```

Tokei's URL scheme is as follows.

```sh
https://tokei.rs/b1/<domain>[<.com>]?/<namespace>/<repository>
```

- `domain`:  The domain name of git host. If no TLD is provided `.com` is added.
  e.g. `tokei.rs/b1/github` == `tokei.rs/b1/github.com`.
- `namespace`: The namespace of the repo. eg. `rust-lang` or `XAMPPRocky`.
- `repository`: the name of the repo eg. `rust` or `tokei`.

## Category

By default the badge will show the repo's total lines, you can also
specify for it to show a different category, by using the `?category=` query
string. It can be either `code`, `blanks`, `files`, `lines`, or `comments`.
Here is an example showing total number of code.
[![lines of code](https://tokei.rs/b1/github/XAMPPRocky/tokei?category=code)](https://github.com/XAMPPRocky/tokei).

```sh
[![](https://tokei.rs/b1/github/XAMPPRocky/tokei?category=code)](https://github.com/XAMPPRocky/tokei).
```

## Type

You can choose to count lines only for specific language type(s), by using the `?type=` query
string. Languages are to be separated by a comma.
Here is an example showing total number of lines for JSON, Rust, and Markdown.
[![lines of json, rust, and markdown](https://tokei.rs/b1/github/XAMPPRocky/tokei?type=JSON,Rust,Markdown)](https://github.com/XAMPPRocky/tokei).

```sh
[![](https://tokei.rs/b1/github/XAMPPRocky/tokei?type=JSON,Rust,Markdown)](https://github.com/XAMPPRocky/tokei).
```

## Branch

You can count lines from a specific branch by using the `?branch=` query
string. If no branch is specified, the default `HEAD` branch will be used.
Here is an example for the `beta` branch.
[![beta](https://tokei.rs/b1/github/rust-lang/rust?branch=beta)](https://github.com/rust-lang/rust).

```sh
[![](https://tokei.rs/b1/github/rust-lang/rust?branch=beta)](https://github.com/rust-lang/rust).
```

## Label

You can customize the badge label by using the `?label=` query string. For example, [![custom label](https://tokei.rs/b1/github/XAMPPRocky/tokei?category=code&label=custom%20label)](https://github.com/XAMPPRocky/tokei).

```sh
[![](https://tokei.rs/b1/github/XAMPPRocky/tokei?category=code&label=custom%20label)](https://github.com/XAMPPRocky/tokei).
```

## Style

By default, the badge uses the "flat" style. You can customize the badge style by using the `?style=` query string. Supported styles are `flat`, `flat-square`, `plastic`, `for-the-badge`, and `social`. For example, [![custom style](https://tokei.rs/b1/github/XAMPPRocky/tokei?category=code&style=for-the-badge)](https://github.com/XAMPPRocky/tokei).

```sh
[![](https://tokei.rs/b1/github/XAMPPRocky/tokei?category=code&style=for-the-badge)](https://github.com/XAMPPRocky/tokei).
```

## Color

By default, the badge uses the color blue `#007ec6`. You can customize the badge color by using the `?color=` query string. Supported color formats include named colors and RGB hexadecimal, a full list of supported formats can be found [here](https://crates.io/crates/csscolorparser). For example, [![custom color](https://tokei.rs/b1/github/XAMPPRocky/tokei?category=code&color=ff0000)](https://github.com/XAMPPRocky/tokei).

```sh
[![](https://tokei.rs/b1/github/XAMPPRocky/tokei?category=code&color=ff0000)](https://github.com/XAMPPRocky/tokei).
```

## Logo

You can customize the badge logo (SVG format) by passing its full URL to the `?logo=` query string. For example, [![custom logo](https://tokei.rs/b1/github/XAMPPRocky/tokei?category=code&logo=https://simpleicons.org/icons/rust.svg)](https://github.com/XAMPPRocky/tokei).

```sh
[![](https://tokei.rs/b1/github/XAMPPRocky/tokei?category=code&logo=https://simpleicons.org/icons/rust.svg)](https://github.com/XAMPPRocky/tokei).
```

## Most Used Language

Instead of showing the number of lines, you can display the name of the n-th most used language by enabling `?showLanguage=true` and using the `?languageRank=` query
string (e.g. `?languageRank=1` for most used language, `?languageRank=2` for 2nd most used language etc.).

Here is an example showing the top 3 most used languages in <https://github.com/XAMPPRocky/tokei>.
[![Most Used Language](https://tokei.rs/b1/github/XAMPPRocky/tokei?showLanguage=true&languageRank=1&label=Most%20Used%20Language)](https://github.com/XAMPPRocky/tokei).
[![2nd Most Used Language](https://tokei.rs/b1/github/XAMPPRocky/tokei?showLanguage=true&languageRank=2&label=2nd%20Most%20Used%20Language)](https://github.com/XAMPPRocky/tokei).
[![3rd Most Used Language](https://tokei.rs/b1/github/XAMPPRocky/tokei?showLanguage=true&languageRank=3&label=3rd%20Most%20Used%20Language)](https://github.com/XAMPPRocky/tokei).

```sh
[![](https://tokei.rs/b1/github/XAMPPRocky/tokei?showLanguage=true&languageRank=1&label=Most%20Used%20Language)](https://github.com/XAMPPRocky/tokei).
[![](https://tokei.rs/b1/github/XAMPPRocky/tokei?showLanguage=true&languageRank=2&label=2nd%20Most%20Used%20Language)](https://github.com/XAMPPRocky/tokei).
[![](https://tokei.rs/b1/github/XAMPPRocky/tokei?showLanguage=true&languageRank=3&label=3rd%20Most%20Used%20Language)](https://github.com/XAMPPRocky/tokei).
```

## Copyright and License

See [the graph](https://github.com/XAMPPRocky/tokei_rs/graphs/contributors) for a full list of contributors.

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

See [LICENSE-APACHE](./LICENSE-APACHE), [LICENSE-MIT](./LICENSE-MIT) for more information.

tokei_rs

tokei_rs Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

tokei_rs

tokei_rs Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README