Skip to content
Browse documentation
Add data / ATH documentation

ath log

Write one plain-text record or one validated structured batch.

Usage

$ath log fran in 4:41 rx

Arguments

[entry...]
Optional text to log. Omit it to paste multiline text and finish with Ctrl-D.

What it does

Plain text covers common results, measurements and athlete reports. A structured object or array can create supported v1 record types in one validated batch. Every item is validated and previewed before one transaction writes the batch. Hand-entered measurements remain marked as manual.

record_id and created_at may be supplied beside record_type; when omitted, ath creates a UUIDv7 record ID and uses the current time.

Structured logging cannot create prediction_result_link or prediction_grade records, including in a batch. Those come from automatic result handling when a benchmark result matches exactly one open prediction, or from ath grade afterward. No file is copied during a JSON preview.

Examples

Run ath log without text to paste one structured record or array and finish with Ctrl-D. Attach PNG, JPEG, WebP or PDF files up to 25 MiB to one athlete report or nutrition entry. When a benchmark result matches exactly one open prediction, the same transaction also creates the link and grade.

$ath log sore quads 4/5
$ath log fran in 4:41 rx --dry-run
$ath log Meal photo --attachment ./receipt.png

Options

--benchmark <name>
name the workout yourself, instead of naming it after the day
--at <timestamp>
exact UTC event time with milliseconds; defaults to now
--agent <name>
name the agent making a structured write
--attachment <path>
attach a supported image or PDF; repeat for several files
--file <path>
write to a file other than the one in this folder
-y, --yes
write it without asking — for scripts, and when you are sure
--dry-run
show what would be written, and write nothing
--json
structured preview; never confirms the write

Related commands

Up nextath link →