Get started
Your First Artifact
Artifacts are how you track work in Spruce. In this walkthrough, you'll create a feature, give it a description and a few field values, and see how it lands on disk.
- Create a feature
Click the pencil icon in the sidebar header. Pick Feature, give it a title ("My first feature"), set any fields you want, and click Save.
Create dialog with the type picker, a title field, pinned-field chips, and a Save button
Spruce writes a new markdown file to
artifacts/feature/SPR-xxxxx.mdinside your Spruce project directory and opens the artifact editor. - Write a description
The body of the artifact is a full markdown editor. Write a few sentences about what this feature does. You can use lists, code blocks, tables, inline code, and links: anything Spruce renders will work.
Artifact editor with a description in the body and pinned field chips at the top
- Set fields
At the top of the editor you'll see chips for Status, Priority, Size, and Assignee. Click any chip to edit. Fields are defined by the feature template; see Fields, Status, and Priority.
Field values are stored in the artifact's YAML frontmatter. The file is plain markdown on disk; if you ever want to inspect it, see The .spruce Directory for where to find it on your platform.
Auto-save in the editor
Once the artifact is created and open, there's no save button on the editor itself; Spruce writes changes to disk as you type. The sync menu in the sidebar header shows pending changes; click it to commit and push the Spruce project to its git remote.
What you just created
A markdown file with your feature's ID, written to your Spruce project's artifacts/feature/ folder. No database, no hidden state, just text. When you sync, the whole project (including this file) is committed and pushed.
Related
- Artifact Types — feature, task, bug, chore, memo.
- The Artifact Editor — deeper on fields, links, and attachments.
- Artifact Relationships — linking artifacts to each other (tasks under a feature, bugs against a feature).
- The .spruce Directory — the on-disk layout of a Spruce project.
- Hand Work to an Agent — next step, implement this feature with an agent.