Getting started

Pre-v1 software

tak's CLI, configuration, storage format, and behavior are not finalized. Expect breaking changes between releases.

These docs are currently AI slop and have not been fully reviewed. They will be reviewed and finished later.

Install

Install the published crate:

cargo install tak-cli

Prebuilt binaries may also be available on the GitHub releases page.

Instruction counting requires Valgrind and is unavailable on Apple Silicon and Windows. Without it, tak records timing only.

Measure one command

Put the command after -- so tak never interprets its flags:

tak run -- mycli --version

Use --bench to give an ad-hoc measurement a stable name:

tak run --bench startup -- mycli --version

Declare repeatable benchmarks

Create tak.toml in the project root:

[bench.startup]
cmd = ["./target/release/mycli", "--version"]

[bench.help]
cmd = "mycli --help"
runs = 10

Then run every declaration or select one:

tak run
tak run --bench startup

String commands are split on whitespace. There is no shell, quoting, globbing, or pipeline syntax. Use an argument list when boundaries matter.

Continue with adopting tak in a project, benchmark configuration, or recording results in git notes.