Timebook CLI

⏰ Time travel for your code

Timebook automatically creates snapshots of your project every 5 minutes, giving you a visual timeline of your work. Never lose progress again.

🚀 Quick Start

# Install globally
npm install -g timebook-cli

# Login with your Timebook account
timebook login

# Link your project
cd your-project
timebook link

# Start automatic snapshots
timebook sync --initial

That's it! Timebook is now watching your project and creating snapshots automatically.

📖 Features

• 🔄 Automatic Snapshots - Every 5 minutes when files change
• 🖥️ Background Agent - Runs silently, no terminal needed
• 🌐 Web Dashboard - View and browse snapshots at console.timebook.sh
• 📁 Smart Ignore - Respects .gitignore and .timebookignore
• 🔐 Secure - End-to-end encrypted snapshots
• ⚡ Fast - Only uploads changed files

📋 Commands

Initial Setup

timebook login              # Login with Personal Access Token
timebook link               # Link current project to Timebook
timebook sync --initial     # Upload initial snapshot & start agent

Daily Usage

timebook sync               # Manually create a snapshot
timebook status             # Check sync status
timebook watch              # Start the background agent
timebook stop               # Stop the background agent

Advanced

timebook daemon status      # Check if agent is running
timebook daemon logs        # View agent logs
timebook daemon logs -f     # Follow logs in real-time

🔧 Configuration

.timebookignore

Create a .timebookignore file in your project root to exclude files:

node_modules/
.git/
dist/
.env*

Environment Variables

# Use custom API endpoint (for development)
export TIMEBOOK_API_BASE=http://localhost:8787

🆘 Troubleshooting

Agent not creating snapshots?

# Check if agent is running
timebook daemon status

# View logs
timebook daemon logs

# Restart agent
timebook stop
timebook watch

"Initial sync not completed" error?

You must run timebook sync --initial before starting the agent:

timebook sync --initial

🌐 Web Dashboard

View your project timeline at: console.timebook.sh

Features:

• 📊 Visual timeline of all snapshots
• 🔍 Browse file contents at any point in time
• 📝 Add notes to snapshots
• ⬇️ Download entire snapshots

📄 License

MIT

🔗 Links

• 🌐 Website: timebook.sh
• 📊 Dashboard: console.timebook.sh
• 🐛 Issues: GitHub Issues
• 📧 Support: [email protected]

Made with ❤️ by mintygum