Logbook
/install logbook
LogBook
LogBook is a data processing and analysis toolkit for querying, importing, exporting, transforming, validating, and visualizing datasets from the terminal. It provides 10 core commands for working with structured data, plus built-in history logging and a quick dashboard view. All operations are local — no external APIs, databases, or network connections required.
Commands
| Command | Description |
|---|---|
logbook query \x3Cargs> |
Query data from the local data store. Logs the query action to history for auditing. |
logbook import \x3Cfile> |
Import a data file into the local store. Accepts any file path as input. |
logbook export \x3Cdest> |
Export processed results to a specified destination (defaults to stdout). |
logbook transform \x3Csrc> \x3Cdst> |
Transform data from one format or structure to another. |
logbook validate \x3Cargs> |
Validate data against the built-in schema. Reports schema compliance status. |
logbook stats \x3Cargs> |
Display basic statistics — total record count from the data log. |
logbook schema \x3Cargs> |
Show the current data schema. Default fields: id, name, value, timestamp. |
logbook sample \x3Cargs> |
Preview the first 5 records from the data store, or "No data" if the store is empty. |
logbook clean \x3Cargs> |
Clean and deduplicate the data store, removing redundant entries. |
logbook dashboard \x3Cargs> |
Quick dashboard showing total record count and summary metrics. |
logbook help |
Show help with all available commands and usage information. |
logbook version |
Print version string (logbook v2.0.0). |
Data Storage
All data is stored locally in ~/.local/share/logbook/ (override with LOGBOOK_DIR or XDG_DATA_HOME environment variables).
Directory structure:
~/.local/share/logbook/
├── data.log # Main data store (line-based records)
└── history.log # Unified activity log with timestamps
Every command logs its action to history.log with a timestamp (MM-DD HH:MM) for full traceability. The main data file data.log holds all imported and processed records.
Requirements
- Bash (with
set -euo pipefail) - Standard Unix utilities:
date,wc,head,du,echo - No external dependencies, databases, or API keys required
- Optional: Set
LOGBOOK_DIRenvironment variable to customize the data directory location
When to Use
- Importing and querying datasets — Pull in CSV, log, or structured data files and run quick queries against them from the terminal without needing a full database setup.
- Data validation workflows — Validate incoming data against the built-in schema (
id, name, value, timestamp) before processing to catch format issues early. - Data transformation pipelines — Transform data between formats or structures as part of an ETL-like workflow, all within a lightweight bash script.
- Quick dashboard and statistics — Get instant record counts and summary metrics via
dashboardorstatswithout writing custom aggregation scripts. - Data cleanup and deduplication — Use
cleanto remove duplicate records and normalize the data store before exporting or feeding into downstream analysis.
Examples
# Import a data file
logbook import transactions.csv
# Query the data store
logbook query "status=active"
# View the data schema
logbook schema
# Preview first 5 records
logbook sample
# Get basic statistics (record count)
logbook stats
# Transform data between formats
logbook transform raw.csv cleaned.csv
# Validate data integrity against schema
logbook validate
# Quick dashboard view
logbook dashboard
# Export results
logbook export results.json
# Clean and deduplicate the data store
logbook clean
# Show version
logbook version
Environment Variables
| Variable | Description | Default |
|---|---|---|
LOGBOOK_DIR |
Custom data directory path | ~/.local/share/logbook |
XDG_DATA_HOME |
XDG base data directory (fallback) | ~/.local/share |
Powered by BytesAgain | bytesagain.com | [email protected]
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install logbook - After installation, invoke the skill by name or use
/logbook - Provide required inputs per the skill's parameter spec and get structured output
What is Logbook?
Write journal entries, search history, and export your personal log digitally. Use when journaling thoughts, searching past entries, exporting notes. It is an AI Agent Skill for Claude Code / OpenClaw, with 338 downloads so far.
How do I install Logbook?
Run "/install logbook" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Logbook free?
Yes, Logbook is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Logbook support?
Logbook is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Logbook?
It is built and maintained by BytesAgain2 (@ckchzh); the current version is v2.0.1.