codestats 0.4.0

A CLI tool for analyzing code statistics across different programming languages
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

# Codestats

This is a CLI tool written in Rust to provide detailed analysis about a folder containing source code, with features such as rspecting gitignores, following symlinks, ignoring hidden files, etc.

## Installation

### With cargo

```bash
cargo install codestats
```

### From source

```bash
git clone https://github.com/trypsynth/codestats
cd codestats
cargo install --path .
```

## Usage

Usage: `cs <command>`

### Commands

* analyze: Analyze a directory or file for code statistics.
* langs: List all supported programming languages (currently 410 and counting).
* help: Print program or command help.

### Options

* -h, --help: Print help
* -V, --version: Print version

### Analyze

Analyze a directory or file for code statistics.

Usage: cs analyze [OPTIONS] <PATH>

### Arguments

* <PATH>  The path to analyze. This can be either a directory (which will be recursively analyzed) or a single file. If a directory is provided, all supported source files within it will be analyzed

### Options

* -v, --verbose Enable verbose output.
* -i, --no-gitignore Do not respect .gitignore files.
* -H, --hidden Search hidden files and directories.
* -s, --symlinks Follow symbolic links and include their targets in the analysis. Use with caution as this can lead to infinite loops with circular symlinks.
* -n, --number-style <NUMBER_STYLE> Output number formatting style [default: plain] [possible values: plain, comma, underscore, space].
* -u, --size-units <SIZE_STYLE> Human-readable size units [default: binary] [possible values: binary, decimal].
* -p, --precision <PERCENT_PRECISION> Percentage precision [default: 1].
* -S, --sort-by <LANGUAGE_SORT> Sorting key for languages (and per-file details when verbose) [default: lines] [possible values: lines, code, comments, blanks, files, size, name].
* -d, --sort-dir <SORT_DIRECTION> Sorting direction [default: desc] [possible values: asc, desc].
* -o, --output <OUTPUT> Output format [default: human] [possible values: human, json, csv, markdown, html].
* -h, --help Print help.

### Langs

List all supported programming languages

Usage: `codestats langs`

### Options

* -h, --help  Print help

## License

Codestats is licensed under the [Zlib License](LICENSE).