Skip to content

Templates ​

Each item type has a starter template: the frontmatter with every optional field in a comment, and the sections the app and netherite lint expect. Optional fields start with #; remove the # to use one. {{name}} marks a value that Netherite fills in.

Use them ​

sh
netherite new adr "Use GNU Stow" --template     # the item starts with the template's sections
netherite templates                             # list the types and where each template comes from
netherite templates task                        # print one, to copy into your own file

--body and --body-file replace the template's text. new writes the frontmatter itself, with the fields you give it; the template supplies the sections.

Make them your own ​

Put a file called <type>.md in templates/ inside the content folder (netherite/templates/adr.md by default). It replaces the built-in template for that type in this workspace. Start from the text below. Files in templates/ are not items: they are not indexed and are not linted as items. If one names a frontmatter field the type does not have, netherite lint reports template-unknown-field.

goal ​

markdown
---
id: {{id}}
aliases: [{{id}}]
type: goal
title: {{title}}
created: {{created}}
created_by: {{created_by}}
status: active
# area: Health               # the column the goal sits in on the Goals page
# horizon: 10 years         # forever, or a length such as 6 months or 90d
# due: 2026-12-31
# owner: "@handle"
# tags: [fitness]
---

# {{title}}

What you want to reach, and why it matters, in a few lines.

## Done when

How you will know it is reached: something you can check, not a feeling.

## Notes

Anything worth keeping that does not fit above.

project ​

markdown
---
id: {{id}}
aliases: [{{id}}]
type: project
title: {{title}}
created: {{created}}
created_by: {{created_by}}
goals: [{{goal}}]
status: active
# due: 2026-12-31
# milestone: Beta
# owner: "@handle"
# labels: [backend]
# decisions: [ADR-00001]     # decisions this project depends on
# design: []                 # links to designs
# tags: []
---

# {{title}}

What this project delivers and for which goal.

## Scope

What is in: the parts of the work, one line each.

## Out of scope

What is left out on purpose, so nobody wonders.

## Done when

The result that ends the project.

task ​

markdown
---
id: {{id}}
aliases: [{{id}}]
type: task
title: {{title}}
created: {{created}}
created_by: {{created_by}}
project: {{project}}
state: backlog
# assignees: ["@handle"]
# labels: [bug]
# depends_on: [TASK-00001]   # tasks that must be done first
# decisions: [ADR-00001]     # decisions this task follows
# related: [DOC-00001]       # anything else that helps
# due: 2026-12-31
# tags: []
---

# {{title}}

What needs doing and why, in one or two lines.

## Checklist

- [ ] First thing that must be true when this is done
- [ ] Second thing

## Notes

What was learned, what was tried, links.

adr ​

markdown
---
id: {{id}}
aliases: [{{id}}]
type: adr
title: {{title}}
created: {{created}}
created_by: {{created_by}}
status: proposed
date: {{date}}
deciders: [{{created_by}}]
# project: PRJ-00001
# supersedes: [ADR-00001]    # decisions this one replaces
# superseded_by: ADR-00002   # set when a later decision replaces this one
# tags: []
---

# {{title}}

## Context

The forces at play: what is the situation, what is being asked, what limits the choice.

## Decision

> What was chosen, in the active voice: "We use X for Y."
>
> - A bullet for each part of the decision.

## Consequences

- \+ What gets easier or better.
- \- What gets harder, and what is given up.

doc ​

markdown
---
id: {{id}}
aliases: [{{id}}]
type: doc
title: {{title}}
created: {{created}}
created_by: {{created_by}}
# covers: ["src/**"]         # the files this describes; it shows as stale when they change
# reviewed_at: 2026-01-15    # the day it was last checked against them
# owner: "@handle"
# project: PRJ-00001
# explains: [ADR-00001]      # decisions or items this gives the background of
# status: active             # deprecated or superseded when it is retired
# supersedes: []
# superseded_by: DOC-00002
# tags: []
---

# {{title}}

One paragraph: what this describes and who it is for.

## How it works

The parts, and how they fit together.

## How to use it

The common tasks, each with an example.

## Limits

What it does not do, and where it can surprise you.

context ​

markdown
---
id: {{id}}
aliases: [{{id}}]
type: context
title: {{title}}
created: {{created}}
created_by: {{created_by}}
include_in_context: true     # handed to agents; "netherite context sync" writes it to CLAUDE.md and AGENTS.md
priority: normal             # high, normal or low: what goes first when the token budget is short
# targets: [claude, agents]  # claude, agents, or mcp (served over MCP only)
# covers: ["src/**"]
# reviewed_at: 2026-01-15
# owner: "@handle"
# project: PRJ-00001
# status: active
# tags: []
---

# {{title}}

Rules and background an agent needs before it works here. Short, concrete and checkable: every
line costs tokens on every task.

## Rules

- One rule per line, written as an instruction.

## Layout

- Where things live, one line each.

runbook ​

markdown
---
id: {{id}}
aliases: [{{id}}]
type: runbook
title: {{title}}
created: {{created}}
created_by: {{created_by}}
# covers: ["scripts/deploy.sh"]  # the files these steps run; it shows as stale when they change
# reviewed_at: 2026-01-15
# owner: "@handle"
# project: PRJ-00001
# explains: []
# status: active
# supersedes: []
# superseded_by: RUN-00002
# tags: []
---

# {{title}}

When to use this runbook, in one line.

## Before you start

What you need: access, tools, a clean state.

## Steps

1. The first step, as a command or an action.
2. The next one.

## Check it worked

How to tell the result is right.

## If it goes wrong

What to do, and who to ask.

MIT licensed. Nothing is sent anywhere: it runs on your machine.