Job API Reference
This page is generated from reme/config/default.yaml. It describes callable jobs in the default application; plugins and custom configurations may add, remove, or override jobs. Run reme help to inspect the active service.
Background and cron jobs are not service-exposed and are omitted from the callable reference.
Memory evolution
auto_dream
Auto-dream: scan today's day-index and daily notes, globally extract merged units/topics, integrate digest units, write interests.yaml, and persist the dream catalog.
reme auto_dream ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date | string | no | YYYY-MM-DD to scan; defaults to today in the dreamer's timezone | |
hint | string | no | caller guidance passed through to dream extract/integrate | |
scan_days | integer | no | 2 | number of recent daily directories to scan, ending at date |
max_units | integer | no | 5 | maximum number of extracted memory units |
topic_count | integer | no | 3 | maximum number of final daily interest topics |
topic_diversity_days | integer | no | 7 | number of previous interests.yaml days to avoid repeating |
auto_memory
Auto-memory: record conversation facts into a daily note
reme auto_memory ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messages | object[] | yes | — | messages |
session_id | string | no | source conversation session identifier | |
memory_hint | string | no | — | optional hint |
date | string | no | YYYY-MM-DD daily note date; empty = infer from message timestamps or today |
auto_memory_cc
Auto-memory (Claude Code): record a Claude Code session into a daily note, resolved from its session_id
reme auto_memory_cc ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
session_id | string | yes | — | Claude Code session id; its transcript is resolved from disk |
memory_hint | string | no | — | optional hint |
auto_resource
Auto-resource: interpret resource files into daily notes
reme auto_resource ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
changes | object[] | yes | — | resource change batch, each item has path/file_path and change |
proactive
Proactive: read daily/<date>/interests.yaml and expose the latest user-interest topics.
reme proactive ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date | string | no | YYYY-MM-DD to read; defaults to today in the dreamer's timezone | |
include_content | boolean | no | true | whether to include the raw YAML content in the response answer and metadata |
System and diagnostics
version
return reme package version
reme versionNo parameters.
app_config
return the effective application config with secrets redacted
reme app_configNo parameters.
chat
Stream a read-only agent conversation over the ReMe workspace.
reme chat ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | yes | — | user message |
session_id | string | no | — | agent session to resume |
system_prompt | string | no | — | optional system prompt override |
health_check
return a concise health-check snapshot of reme components
reme health_checkNo parameters.
status
report memory estimates for stateful data components and process RSS
reme statusNo parameters.
help
list all registered jobs with their metadata
reme helpNo parameters.
Retrieval and graph
traverse
Return a bounded wikilink graph with frontend-ready nodes and directed edges.
reme traverse ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
path | string or string[] | yes | — | workspace-relative path or paths used as graph seeds |
depth | integer | no | 1 | maximum number of wikilink hops |
direction | string | no | both | traversal direction; returned edges always preserve the original wikilink source-to-target direction |
graph_snapshot
Return the category-rooted digest wikilink graph with daily-note leaves.
reme graph_snapshotNo parameters.
reindex
rebuild BM25 and/or embedding indexes from current file_chunks
reme reindex ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
scope | string | no | all | — |
search
Hybrid workspace search (vector + BM25, RRF-fused).
reme search ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | yes | — | search query |
limit | integer | no | 5 | max results |
min_score | number | no | 0 | min fused score |
start_date | string | no | — | optional inclusive start date filter (YYYY-MM-DD); results earlier than this date are excluded |
end_date | string | no | — | optional inclusive end date filter (YYYY-MM-DD); results later than this date are excluded |
node_search
Digest node recall — given a candidate abstraction's name+description, surface existing digest nodes similar enough to either dedup against or link to as related.
reme node_search ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | yes | — | search query |
limit | integer | no | 20 | max digest nodes to return |
Daily notes
daily_list
List notes under a single day.
reme daily_list ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date | string | no | YYYY-MM-DD; empty = today |
daily_reindex
Rebuild the day-index page daily/<date>.md.
reme daily_reindex ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date | string | no | YYYY-MM-DD; empty = today |
daily_write
Write a daily markdown note with conversation source frontmatter.
reme daily_write ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | yes | — | daily note filename stem and frontmatter name |
description | string | yes | — | frontmatter description |
session_id | string | yes | — | source conversation session identifier |
content | string | yes | — | body |
date | string | no | YYYY-MM-DD daily note date; empty = today | |
metadata | object | no | — | Optional extra frontmatter fields. |
File operations
frontmatter_delete
Drop keys from a file's frontmatter.
reme frontmatter_delete ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
path | string | yes | — | workspace-relative path |
keys | string[] | yes | — | keys to remove |
frontmatter_read
Read a file's frontmatter as a dict.
reme frontmatter_read ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
path | string | yes | — | workspace-relative path |
frontmatter_update
Merge key-values into a file's frontmatter.
reme frontmatter_update ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
path | string | yes | — | workspace-relative path |
metadata | object | yes | — | key-values to merge |
stat
Stat path (size, mtime, exists, is_dir, is_file).
reme stat ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
path | string | yes | — | workspace-relative path |
list
List files under a workspace path.
reme list ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
path | string | no | workspace-relative dir; empty = root | |
recursive | boolean | no | false | recurse |
sort_by | string | no | — | optional ordering; mtime returns most recently modified files first |
extensions | string[] | no | — | optional extension allowlist applied before sorting and limiting |
limit | integer | no | 100 | max results |
move
Move / rename a workspace file; rewrites inbound wikilinks by default.
reme move ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
src_path | string | yes | — | workspace-relative source |
dst_path | string | yes | — | workspace-relative destination |
overwrite | boolean | no | false | overwrite if dst exists |
retarget | boolean | no | true | rewrite [[src]] → [[dst]] across the workspace |
delete
Delete a workspace file or folder; returns surviving inbound wikilinks.
reme delete ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
path | string | yes | — | workspace-relative path |
read
Read a markdown file under the workspace.
reme read ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
path | string | yes | — | workspace-relative path; markdown only |
start_line | integer | no | — | first line (1-based, inclusive) |
end_line | integer | no | — | last line (1-based, inclusive) |
load
Load a complete text file for the local editor without agent-output truncation.
reme load ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
path | string | yes | — | workspace-relative path |
read_image
Read an image file as base64 (workspace-relative path).
reme read_image ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
path | string | yes | — | workspace-relative path; common image formats supported (png/jpg/jpeg/webp/gif/bmp/tiff/heic) |
write
Write a markdown file (create or overwrite) with name/description frontmatter.
reme write ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
path | string | yes | — | workspace-relative path; markdown only |
name | string | yes | — | frontmatter name |
description | string | yes | — | frontmatter description |
content | string | yes | — | body |
metadata | object | no | — | Optional extra frontmatter fields (md only). |
save
Save text verbatim, optionally rejecting external changes since the file was opened.
reme save ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
path | string | yes | — | workspace-relative path |
content | string | yes | — | complete file content, including frontmatter |
expected_mtime | string | no | — | optional ISO mtime returned by stat |
edit
Find-and-replace in a markdown file (all occurrences).
reme edit ...| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
path | string | yes | — | workspace-relative path |
old | string | yes | — | text to find |
new | string | yes | replacement |