Skip to content
Frank edited this page Nov 8, 2026 · 2 revisions

Waymark

Work items are Markdown files in your repo. No database, no daemon — git clone is the whole install.

Waymark is a local-first, Git-friendly work tracker. One Markdown file per work item, YAML frontmatter, under work/; configuration in .waymark/. Git holds the history, so a ticket can be reviewed, diffed, and reverted like code.

Pre-1.0. The document format and the CLI may still change between releases. The macOS and Windows binaries are unsigned, so verify every archive against its .sha256 before running it.

Packages

Both variants are built from the same tag and read the same project format:

  • Basic — the waymark CLI and the waymark-mcp Model Context Protocol server.
  • Web — the same commands plus the read-only Web view served by waymark serve.

Neither variant downloads or installs anything at run time.

Install

Download the archive for your platform from the Releases, check it against its .sha256, extract it, and put the extracted directory on PATH. The full walkthrough, including the unsigned-binary notes for macOS and Windows, is in the README.

With a Rust toolchain the same binaries also install from crates.io:

cargo install waymark-cli   # the `waymark` binary
cargo install waymark-mcp   # the MCP server

The CLI crate is waymark-cli, not waymark: waymark on crates.io is an unrelated crate.

First commands

waymark init
waymark create --title "Try Waymark" --category task --owner "Your Name"
waymark list

waymark init creates .waymark/config.toml and the category directories under work/. waymark --help lists every command in this release, and waymark agent-doc prints the same reference as a Markdown capability document for agents.

Where to go next

Topic Link
Full install guide, Web view, build from source README
Point Claude Code, DSH, or a generic MCP client at a project MCP clients
Local CI gates and development setup Development
Why the archive is irreversible, the write lock, error codes ADRs
Domain vocabulary: work item, category, owner, operator Glossary
Release history Changelog
Reporting a vulnerability Security
简体中文 README.zh-CN.md

Waymark is dual-licensed under either the MIT Licence or the Apache License, Version 2.0, at your option.