Getting started

Setup, interactive workflow and touchstone script execution.

use_touchstone()

Initiate touchstone

use_touchstone_workflows()

Use touchstone GitHub Actions Workflows

activate() deactivate()

Activate touchstone environment

run_script()

Sources a script

Scripting functionality

Functions you usually want to call in your touchstone script.

branch_install()

Install branches

benchmark_run()

Run a benchmark for git branches

benchmark_analyze()

Turn raw benchmark results into text and figures

Pinning

Working with assets across branches.

pin_assets()

Pin asset directory

path_pinned_asset()

Get path to asset

Non-function documentation

Not functions, but worth documenting anyways.

touchstone_script

The script for benchmarking

pr_comment

Modifying the PR Comment

i/o

Low-level tools for accessing the touchstone datastore.

benchmark_ls()

List which benchmarks were recorded

benchmark_read()

Read benchmarks

benchmark_write()

Write a benchmark

dir_touchstone() touchstone_clear() path_pr_comment()

Touchstone managers

Misc

Miscellaneous.

branch_get_or_fail()

Get the branch from the environment variable or fail if not set