tokmd 1.3.0

Tokei-backed repo inventory receipts (Markdown/TSV/JSONL/CSV) for PRs, CI, and LLM workflows.
Documentation 
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

# tokmd


CLI binary for tokmd - code intelligence for humans, machines, and LLMs.

## Overview


This is the **Tier 5** entry point that orchestrates all other crates. It provides the `tokmd` command-line application for generating code inventory receipts, analysis reports, and LLM context.

## Installation


```bash
# From crates.io

cargo install tokmd

# From source

cargo install --path crates/tokmd

# With Nix

nix profile install github:EffortlessMetrics/tokmd
```

## Quick Start


```bash
# Language summary (Markdown)

tokmd

# Module breakdown

tokmd module --module-roots crates,packages

# Pack for LLM context

tokmd context --budget 128k --output bundle > context.txt

# Analysis report

tokmd analyze --preset risk --format md

# Generate badge

tokmd badge --metric lines --out badge.svg
```

## Commands


| Command | Description |
|---------|-------------|
| `tokmd` / `tokmd lang` | Language summary |
| `tokmd module` | Module breakdown by directory |
| `tokmd export` | File-level inventory (JSONL/CSV/CycloneDX) |
| `tokmd run` | Full scan with artifact output |
| `tokmd analyze` | Derived metrics and enrichments |
| `tokmd badge` | SVG badge generation |
| `tokmd diff` | Compare two runs or receipts |
| `tokmd cockpit` | PR metrics with evidence gates for code review |
| `tokmd gate` | Policy-based quality gates with JSON pointer rules |
| `tokmd tools` | Generate LLM tool definitions (OpenAI, Anthropic, JSON Schema) |
| `tokmd context` | Pack files into LLM context window |
| `tokmd init` | Generate .tokeignore template |
| `tokmd check-ignore` | Explain why files are ignored |
| `tokmd completions` | Generate shell completions |

## Feature Flags


```toml
[features]
default = ["git", "walk", "content"]
alias-tok = []   # Enable `tok` binary alias
git = []         # Git history analysis
walk = []        # Asset discovery
content = []     # Content scanning
```

## Configuration


Supports `tokmd.toml` configuration files with:
- Scan settings (excludes, ignore handling)
- Module settings (roots, depth)
- Export settings (format, redaction)
- Analysis settings (presets, limits)
- Named profiles for different workflows

## Exit Codes


| Code | Meaning |
|------|---------|
| 0 | Success |
| 1 | General error (includes non-existent paths) |
| 2 | CLI parsing error |

## Dependencies


Coordinates all tokmd crates:
- `tokmd-analysis` with git, walk, content features
- `tokmd-analysis-format` with fun feature
- `tokmd-config`, `tokmd-core`, `tokmd-format`
- `tokmd-model`, `tokmd-scan`, `tokmd-types`
- `tokmd-tokeignore`

## Documentation


- [Tutorial](../../docs/tutorial.md)
- [CLI Reference](../../docs/reference-cli.md)
- [Recipes](../../docs/recipes.md)
- [Troubleshooting](../../docs/troubleshooting.md)

## License


MIT OR Apache-2.0