README
¶
livt
Collaborate on board. Make it living in text.
Documentation | Getting Started | Guides | Commands
What is livt?
livt is a CLI tool that captures collaborative discovery outcomes as living text. It bridges the gap between synchronous discovery sessions (like Opportunity Canvas, User Story Mapping and Example Mapping) and development artifacts.
Discovery outcomes are written as plain text files (YAML, Markdown) and visualized as boards:
Features
- Opportunities -- Say why the work is worth doing, and hold it on an Opportunity Canvas rendered as a single sheet
- Stories as Markdown -- Write stories with YAML frontmatter, keep them alongside your code
- Story Maps -- Visualize activities, user tasks, and stories with release slices on a board
- Example Mappings -- Render rules, examples, and questions as color-coded sticky notes
- Ubiquitous Language -- Keep shared terms as Markdown files and browse them as a glossary table
- Static HTML output --
livt buildgenerates a standalone site, no runtime required - Local dev server --
livt servebuilds and serves with one command - English or Japanese -- pick the site's language in
livt.yaml; your own prose is rendered as written
Installation
See the Installation guide for details on how release artifacts are verified.
Prebuilt binaries
Download the archive for your platform from GitHub Releases.
Every artifact is listed in checksums.txt (SHA-256) and carries a Sigstore-signed build provenance attestation, so you can verify it was built by this repository's release workflow before running it:
gh attestation verify livt_<version>_<os>_<arch>.tar.gz --repo boykush/livt
mise
mise use "github:boykush/livt@<version>"
The github backend downloads the release binary and, by default, verifies its GitHub artifact attestation (Sigstore build provenance). With lockfile = true, the checksum and provenance are also pinned in mise.lock.
To build from source instead, use the go backend (requires Go; verified by the Go checksum database):
mise use "go:github.com/boykush/livt@<version>"
go install
go install github.com/boykush/livt@<version>
Quick Start
# Create the directory structure
mkdir -p opportunities stories discoveries/opportunity-canvases discoveries/usm discoveries/example-mappings ubiquitous
# Create your first story
cat <<'EOF' > stories/my-first-story.md
---
name: My first story
---
As a user
I want to do something
So that I get value
EOF
# Build and serve
livt serve
Open http://localhost:3000 in your browser.
See the Getting Started guide for more details.
File Structure
opportunities/
{opportunity-key}.md # Opportunity files
stories/
{story-key}.md # Story files
discoveries/
opportunity-canvases/
{opportunity-key}.yaml # Opportunity canvas files
usm/
{opportunity-key}.yaml # Story map files
example-mappings/
{story-key}.yaml # Example mapping files
See File Structure reference for output details.
Contributing
Issues and pull requests are welcome — see CONTRIBUTING.md. For vulnerability reports, see SECURITY.md.
License
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
config
Package config reads livt.yaml, the site config at the root of the livt repository.
|
Package config reads livt.yaml, the site config at the root of the livt repository. |
|
i18n
Package i18n holds the message catalogs for the site chrome — nav labels, headings, legends, empty states.
|
Package i18n holds the message catalogs for the site chrome — nav labels, headings, legends, empty states. |
|
mcp
Package mcp serves the livt repository (opportunities and their canvases, story maps, stories, example mappings, ubiquitous language) over the Model Context Protocol so implementation repos can fetch the spec for a story or rule without reading livt's source.
|
Package mcp serves the livt repository (opportunities and their canvases, story maps, stories, example mappings, ubiquitous language) over the Model Context Protocol so implementation repos can fetch the spec for a story or rule without reading livt's source. |
|
server
Package server builds artifacts and serves them with live reload, so edits to discovery and story files are previewed in the browser while editing.
|
Package server builds artifacts and serves them with live reload, so edits to discovery and story files are previewed in the browser while editing. |
|
uri
Package uri builds and parses livt URIs — the deployment-independent way to address one point of the spec: an opportunity, its canvas, a story map, a story, an example mapping, a rule, an example, a question, or a ubiquitous language term.
|
Package uri builds and parses livt URIs — the deployment-independent way to address one point of the spec: an opportunity, its canvas, a story map, a story, an example mapping, a rule, an example, a question, or a ubiquitous language term. |