Skip to content
⚗️ Crucible

Workflow Markup

⚠️ Planned Feature: This feature is not yet implemented. The documentation below describes the intended design.

Workflow Markup

Section titled “Workflow Markup”

Workflow markup lets you define automated processes using natural language with embedded structure.

Basic Syntax

Section titled “Basic Syntax”

Workflows are written in prose with embedded commands:

# My Workflow


First, search for notes tagged with #inbox.
Then, for each note, analyze the content and suggest categories.
Finally, move processed notes to the appropriate folder.

The parser understands:

  • Action verbs (search, create, move, update)
  • References (notes, folders, tags)
  • Conditions (if, when, for each)
  • Sequences (first, then, finally)

Structure Elements

Section titled “Structure Elements”

Steps

Section titled “Steps”

Each paragraph is a step:

Search for all notes in the Inbox folder.


For each note found, extract the main topic.


Create a summary note with links to all processed notes.

Conditions

Section titled “Conditions”

Use natural conditionals:

If the note has no tags, suggest tags based on content.


When a note is older than 30 days, mark it for review.

Loops

Section titled “Loops”

Process multiple items:

For each project note, check for incomplete tasks.


Process all notes modified today.

Variables and Context

Section titled “Variables and Context”

Workflows maintain context between steps:

Find all meeting notes from this week.
(This creates a list of notes)


For each meeting note, extract action items.
(Operates on the list from previous step)


Create a task list combining all action items.
(Uses accumulated results)

Integration with Kiln

Section titled “Integration with Kiln”

Searching

Section titled “Searching”
Search semantically for "project updates".
Find notes tagged with #important and #urgent.
Get all notes in the Projects/ folder.

Creating

Section titled “Creating”
Create a new note called "Weekly Summary" in Summaries/.
Add today's date to the frontmatter.
Include links to all notes found.

Updating

Section titled “Updating”
Update the status to "reviewed".
Add the tag #processed.
Set the reviewed_at property to now.

Example Workflows

Section titled “Example Workflows”

Inbox Processing

Section titled “Inbox Processing”
# Inbox Processing


Find all notes in the Inbox folder.


For each note:
  - Analyze the content to determine the topic
  - Suggest appropriate tags
  - Recommend a destination folder


After processing, create a summary of changes.

Weekly Review

Section titled “Weekly Review”
# Weekly Review


Gather all notes modified in the last 7 days.
Group them by their folder.


For each group, create a section in the review:
  - List the notes with brief descriptions
  - Highlight any notes marked important
  - Note any incomplete tasks


Save the review to Reviews/[today's date].md.

Relation to YAML Workflows

Section titled “Relation to YAML Workflows”

[!warning] The YAML workflow format is being replaced by prose markup.

The current Help/Extending/Workflow Authoring describes YAML-based workflows. The prose markup format is intended to be more natural and readable while providing the same capabilities.

See Also

Section titled “See Also”