Getting Started

<dependency>
    <groupId>io.github.markpollack</groupId>
    <artifactId>journal-core</artifactId>
    <version>1.6.0</version>
</dependency>

import io.github.markpollack.journal.Journal;
import io.github.markpollack.journal.storage.JsonFileStorage;
import java.nio.file.Path;

Journal.configure(new JsonFileStorage(Path.of(".agent-journal")));

import io.github.markpollack.journal.Journal;
import io.github.markpollack.journal.Run;
import io.github.markpollack.journal.event.LLMCallEvent;
import io.github.markpollack.journal.event.ToolCallEvent;
import java.util.Map;

try (Run run = Journal.run("first-experiment")
        .name("attempt-1")
        .agent("example-agent")
        .task("summarize-repository")
        .config("model", "claude-opus-4-5")
        .tag("environment", "local")
        .start()) {

    run.logEvent(LLMCallEvent.of("claude-opus-4-5", 1200, 450, 0.02475));

    run.logEvent(ToolCallEvent.success(
            "Bash",
            Map.of("command", "git status --short"),
            Map.of("exitCode", 0, "output", ""),
            150));

    run.setSummary("success", true);
    run.logArtifact("result.txt", "Repository is clean.");
}

.agent-journal/
└── experiments/
    └── first-experiment/
        ├── experiment.json
        └── runs/
            └── {run-id}/
                ├── run.json
                ├── events.jsonl
                └── artifacts/
                    └── result.txt

{"@type":"header","schemaVersion":1,"stream":"events","runId":"..."}
{"@type":"llm_call","timestamp":"...","provider":null,"model":"claude-opus-4-5","tokenUsage":{"inputTokens":1200,"outputTokens":450,"thinkingTokens":0,"cacheCreationTokens":0,"cacheReadTokens":0,"toolUseTokens":0},"cost":{"inputCostUsd":0.02475,"outputCostUsd":0.0,"thinkingCostUsd":0.0,"cacheSavingsUsd":0.0},"timing":null,"finishReason":null,"responseId":null,"metadata":{}}

import io.github.markpollack.journal.Journal;
import io.github.markpollack.journal.storage.InMemoryStorage;

Journal.reset();
Journal.configure(new InMemoryStorage());

try {
    try (var run = Journal.run("test-experiment").start()) {
        run.setSummary("result", "ok");
    }
} finally {
    Journal.reset();
}