Skip to content

Getting Started

Installation

Homebrew (macOS/Linux)

brew install byronxlg/agentlog/agentlog

Python SDK

pip install agentlog-sdk

TypeScript SDK

npm install agentlog-sdk

Build from source

Requires Go 1.23+:

git clone https://github.com/byronxlg/agentlog.git
cd agentlog
make build

This produces two binaries in bin/: agentlog (CLI) and agentlogd (daemon).

Add them to your PATH:

export PATH="$PWD/bin:$PATH"

Start the daemon

agentlog uses a background daemon to manage writes and queries. Start it:

agentlog start

You should see output like:

agentlogd started (PID 12345)

Write a decision

Log your first decision entry:

agentlog write --type decision \
  --title "Use SQLite for the index" \
  --body "Considered PostgreSQL but SQLite keeps us single-binary and local-first." \
  --tags "architecture,database" \
  --files "internal/index/index.go"

The command prints the entry ID on success.

Query it back

List recent entries:

agentlog log

Full-text search:

agentlog query "SQLite"

See decisions related to a specific file:

agentlog blame internal/index/index.go

Stop the daemon

When you are done:

agentlog stop

Next steps