Skip to main content

Timeliner 🌟 - AI's diary. Track AI agent work with markdown log

Project description

Timeliner

Auto-documenting memory layer for AI coding agents. Timeliner logs your AI development sessions as timestamped markdown files, giving AI agents perfect recall of past decisions, implementations, and context.

Feature Highlights

  • Zero-friction logging - easy-save work via /save command
  • Rich context - Capture outcomes, tags, metadata (PRs, commits, issues)
  • Markdown storage - Human-readable logs
  • MCP integration - Works with Claude Code, RooCode, and other MCP-enabled tools
  • Live documentation - Auto-generated MkDocs site with search and navigation

Use Cases

Software Development:

  • Document decisions and rationale during coding sessions
  • Track refactoring steps
  • Log implementation progress

Research & Learning:

  • Maintain experiment logs with results and insights
  • Build a learning journal
  • Track hypothesis evolution

Installation

Automatic Setup for Claude Code

Run the installer in your project root:

uvx --from tliner@latest tliner-install

Documents stored in docs/timeline/ by default. Customize via Environment Variables

See details below.

Manual Setup for Other MCP Tools

See Manual Installation below.

Quick Start

Using the /save Command

  1. Run /save in your Agent Tool, when you feel you have made significant progress or decisions.
  2. File will be created/updated in your configured TIMELINER_WORK_FOLDER (docs/timeline/ by default).

Using the /report Command

Generate work reports analyzing your Timeline task files: /report <topic> [time_period]

Examples:

  • /report "authentication bug" "last 2 days" - Find work on authentication in recent files
  • /report work done (concise summary) last week - Generate summary of all work from last week

The report groups related work into distinct approaches, showing implementation attempts, outcomes, and current status.

Configuration

Environment Variables

  • TIMELINER_WORK_FOLDER: Storage directory (default: work/docs)
  • add envvar to .claude/settings.json or .claude/settings.local.json :
{ 
  "env": { "TIMELINER_WORK_FOLDER": "info/mydocs"  } 
}

Documentation Browser (Experimental in v0.2.0)

Your timeline files automatically become a searchable doc-UI. Enable MkDocs by adding the --mkdocs flag to the "args" in your MCP server configuration.:

In .mcp.json:

{
  "mcpServers": {
    "timeliner": {
      "command": "uvx",
      "args": ["tliner@latest", "serve", "--mkdocs"],
      "env": {"TIMELINER_WORK_FOLDER": "${PWD}/docs/timeline"}
    }
  }
}

Opens your browser to a live-updating docs site. Every time you save work, the site refreshes. Search anything, jump between tasks, copy file paths—it's all there.

Quick tips:

  • Click task IDs or file paths to copy them
  • Use the search box to find past work instantly
  • "Open in Editor" buttons work with VSCode, Cursor, Zed, and 14 other editors

That's it. Write markdown, get docs.

Note: This feature is experimental and disabled by default. After testing and feedback, it will become core functionality (enabled by default) in v0.3.0.


Advanced Usage

CLI Commands

For manual inspection and debugging:

# List all tasks
TIMELINER_WORK_FOLDER="${PWD}/docs/timeline" uvx tliner@latest task-list

# Show all steps for a task
TIMELINER_WORK_FOLDER="${PWD}/docs/timeline" uvx tliner@latest task-show <task_id>

# Run MCP server manually
TIMELINER_WORK_FOLDER="${PWD}/docs/timeline" uvx tliner@latest serve

Archiving Tasks

Got too many tasks cluttering your timeline? Just toss old ones into year-month folders like 2025_09, 2025_10, etc.

Everything still works—searches, retrieval, CLI commands—but now your root stays clean and MkDocs shows them organized by month. It's like filing papers in dated folders, except the computer remembers where everything is.

Claude Code Modes

  • Two modes available: plugin and standalone
  • Install scriptAuto-detects Claude CLI:
    • If Claude available → installs as plugin (recommended)
    • If not → falls back to standalone mode

Plugin mode (default when Claude detected):

  • Adds sinai-io/ai-plugins marketplace
  • Installs tliner plugin with /tliner:save, /tliner:load, /tliner:report commands

Standalone mode (deprecated, force with --standalone or -w):

uvx --from tliner@latest tliner-install --standalone
uvx --from tliner@latest tliner-install -w custom/path
  • Configures .mcp.json directly
  • Creates /save, /load, /report in .claude/commands/
  • Use when you want full control or custom work folder

Manual Installation

Add/create to .mcp.json in the root folder of your project:

{
  "mcpServers": {
    "timeliner": {
      "type": "stdio",
      "command": "uvx",
      "args": ["tliner@latest", "serve"],
      "env": {"TIMELINER_WORK_FOLDER": "${PWD}/docs/timeline"}
    }
  }
}

Copy commands from our repo to .claude/commands/:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tliner-0.3.0-py3-none-any.whl (39.7 kB view details)

Uploaded Python 3

File details

Details for the file tliner-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: tliner-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 39.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.22

File hashes

Hashes for tliner-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2590ed5504c5f35f3c96cb8df39abe33c6e27139e991eed577ba48626da25050
MD5 393cecb275eb234319114975089b6d49
BLAKE2b-256 97c528e697d0602c5701a1c44377ff70eab27dc506ae816ac334802475a66ab1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page