Documentation
This page routes you to the task you want to complete. Detailed technical references live with the source code and stay versioned with the product.
Get started
Run the included example plans locally with Node.js 22 or newer.
git clone https://github.com/zeitlines/zeitlines.git
cd zeitlines
npm install
npm run devRead the quick start in the repository.
Choose a data source
- JSON: one portable file for the plan.
- Markdown: dated notes and frontmatter from a folder you own.
- Postgres: a shared plan that remains editable after deployment.
Compare local and deployed operation.
Connect an agent through MCP
The MCP server works against a running database-backed deployment. Its reference lists the current tools, required environment variables and authentication model.
Self-host Zeitlines
Publish read-only file plans or connect Postgres for shared editing and remote MCP. Authentication and live-update choices are documented with the deployment path.
Build a plugin
Plugins can add item fields, views, stored data and tools. Authoring starts with the plugin contract, then the playbook covers research, implementation and release.