Skip to main content

Artifacts

Fields, Status, and Priority

Every artifact has a set of fields defined by its template. Most built-in types share a common core: status, priority, size, and assignee.

The common fields

Status

Tracks the state of the work. Each type defines its own status options:

  • Feature / Bug / Chore: BacklogTodoIn ProgressIn ReviewDone (plus Cancelled).
  • Task: simplified to TodoIn ProgressDone.

Status colors and icons are defined in the template so every view, by-type page, and focus bar chip can render them consistently.

Priority

How urgent the work is. Four levels: Urgent, High, Medium, Low. Each has its own color and icon.

Size

An effort estimate: S (1–2h), M (2–4h), L (1–2d), XL (3–5d). Optional.

Assignee

The person responsible. Uses a user field type that picks from the project's user list (users/ folder in the project directory).

Field chips on the editor

At the top of the artifact editor, fields marked with the pinned display hint render as interactive chips. Click a chip to change the value.

Artifact editor header showing status, priority, size, and assignee chipsArtifact editor header showing status, priority, size, and assignee chips

Where field values live

Field values are stored as YAML frontmatter at the top of the artifact's markdown file:

yaml

---
id: SPR-abc123
type: feature
title: My feature
status: In Progress
priority: High
size: M
assignee: alice
---

You can edit these directly in a text editor if you prefer; Spruce picks up changes on reload.

Customizing fields

Field definitions live in the template. Edit a built-in template or create a new one to add custom fields, change status options, or restrict values. See Editing Built-in Templates and Field Types and Options.