Skip to content
diaryx-orgPublic

About

Self-describing plaintext workspaces, based on `fig`

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

562 Commits

Folders and files

Repository files navigation

part_of id:dx4hxn744/kv2bv2m
title prov
author adammharris
created 2026-07-06
contents
[Design](docs/DESIGN.md)
[Spec](/docs/spec.md)
[Getting Started](docs/getting-started.md)
[Querying your files](/docs/querying.md)
[Config Vocab](/docs/config-vocab.md)
[Init Adoption](/docs/init-adoption.md)
[Next Steps](/docs/next-steps.md)
[Reference Styles](/docs/reference-styles.md)
[History Format](/docs/history-format.md)
[Manifests](/docs/manifests.md)
[Provenance](/docs/provenance.md)
[Releasing](/docs/releasing.md)
[Changelog](/docs/CHANGELOG.md)
[Proposals](/docs/proposals/proposals.md)
[Tasks](/docs/tasks/tasks.md)
[Author's notes](/authors-notes.md)
[prov on diaryx.org](/www/index.md)
[Audiences](/vocab/audiences.md)
config prov.yaml
about about.md
registry registry.yaml
id 1ch2991
slug prov
updated 2026-10-13 23:51:28 UTC

prov (Plaintext Records, Organized and Verifiable)

CI license

A self-describing plaintext workspace: a set of documents whose structure lives in the documents' own embedded metadata (frontmatter), not in the filesystem layout or an app-private sidecar folder.

Layout

  • prov/ — the library. Documents, relations, identity, and the workspace seam.
  • prov-cli/ — a thin command-line companion (the installed binary is prov).
  • prov-testkit/ — filesystem scratch helpers the tests share. Never published.
  • xtask/ — the one CI job that is more than a command, cargo xtask package-isolation.

Development

ship ci runs everything CI runs, in the order CI runs it; ship ci --list lists the individual jobs and ship ci <job> runs one. The workflow does nothing but ask ship ci --matrix what the jobs are and run each one, so changing CI means editing the job list in .config/ship.figl and nothing else.

Releases are one command: ship <patch|minor|major|x.y.z> bumps the workspace version, cuts the changelog's unreleased region into a released section, commits and tags — and pushes only when given --push, because the push is what ships the Homebrew binaries. prov is not on crates.io: a Rust project depends on it from git, prov = { git = "https://github.com/diaryx-org/prov", branch = "main" }. See Releasing.

Building needs a Rust toolchain and nothing else: prov's fig and twig-doc dependencies are pure Rust (since fig 7 and twig 6). nix develop provides the pinned toolchain.

Status

Works for simple workspaces. Active work is currently taking place incorporating prov into Diaryx.

License

Licensed under either of

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

About

Self-describing plaintext workspaces, based on `fig`

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages