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.

System and diagnostics

`proactive_refresh`

Refresh proactive topics once for local maintenance or debugging; not exposed by HTTP/MCP.

bash

reme proactive_refresh ...

Parameter	Type	Required	Default	Description
`date`	`string`	no		YYYY-MM-DD to refresh; defaults to today in the application's timezone

`proactive_read`

Proactive: read daily/<date>/interests.yaml and expose the latest user-interest topics.

bash

reme proactive_read ...

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
`horizon_days`	`integer`	no	1	merge interests.yaml across this many recent days (1 = single-day legacy behaviour)
`min_confidence`	`number`	no	0.4	minimum topic confidence to return (default 0.4 sits safely below the 0.5 fallback; v1 topics fall back to 0.5)

`version`

return reme package version

bash

reme version

No parameters.

`app_config`

return the effective application config with secrets redacted

bash

reme app_config

No parameters.

`chat`

Stream a read-only agent conversation over the ReMe workspace.

bash

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

bash

reme health_check

No parameters.

`status`

report memory estimates for stateful data components and process RSS

bash

reme status

No parameters.

`help`

list all registered jobs with their metadata

bash

reme help

No parameters.

`list_tags`

List active tags with file counts. Returns {total_tags, total_pages, page, range, items}; range is the inclusive 1-based item range and each item is [tag, file_count]. A page past the end returns empty items and range [0, 0].

bash

reme list_tags ...

Parameter	Type	Required	Default	Description
`page`	`integer`	no	1	1-based page; values past the end return an empty page
`order_by`	`string`	no	tag	sort by tag or file count
`order`	`string`	no	—	defaults to asc for tag, desc for file_count
`page_size`	`integer`	no	100	items per page

Memory evolution

`auto_dream`

Auto-dream: scan today's day-index and daily notes, globally extract merged units, integrate digest units, and persist the dream catalog.

bash

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

`auto_memory`

Auto-memory: record conversation facts into a daily note

bash

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
`include_images`	`boolean`	no	false	Use session images with a vision-capable AgentScope model; save Base64 originals and cite sources
`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

bash

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

bash

reme auto_resource ...

Parameter	Type	Required	Default	Description
`include_images`	`boolean`	no	true	Process image resource changes with a vision-capable AgentScope wrapper; false skips all image events, including deletes
`changes`	`object[]`	yes	—	resource change batch, each item has path/file_path and change

Retrieval and graph

`traverse`

Return a bounded wikilink graph with frontend-ready nodes and directed edges.

bash

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.

bash

reme graph_snapshot

No parameters.

`reindex`

rebuild BM25, embedding, and/or tag indexes without rescanning workspace files

bash

reme reindex ...

Parameter	Type	Required	Default	Description
`scope`	`string`	no	all	—

`search`

Hybrid workspace search (vector + BM25, RRF-fused).

bash

reme search ...

Parameter	Type	Required	Default	Description
`query`	`string`	yes	—	search query
`limit`	`integer`	no	5	max results
`min_score`	`number`	no	0	Minimum returned score; 0 disables filtering (recommended). Uses native vector or BM25 scores when only one branch has hits, and rank-based RRF scores (at most 1/61, about 0.01639) when both have hits. The scale can change per query; this is not a normalized relevance threshold.
`tags`	`string[]`	no	[]	optional tags filter; a file matches when it contains at least one valid tag
`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.

bash

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.

bash

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.

bash

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.

bash

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.

bash

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.

bash

reme frontmatter_read ...

Parameter	Type	Required	Default	Description
`path`	`string`	yes	—	workspace-relative path

`frontmatter_update`

Merge key-value pairs into a Markdown file's frontmatter while preserving its body and unrelated fields.

bash

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).

bash

reme stat ...

Parameter	Type	Required	Default	Description
`path`	`string`	yes	—	workspace-relative path

`list`

List files under a workspace path.

bash

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.

bash

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.

bash

reme delete ...

Parameter	Type	Required	Default	Description
`path`	`string`	yes	—	workspace-relative path

`read`

Read a markdown file under the workspace.

bash

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.

bash

reme load ...

Parameter	Type	Required	Default	Description
`path`	`string`	yes	—	workspace-relative path

`read_image`

Read an image file as base64 (workspace-relative path).

bash

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.

bash

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.

bash

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).

bash

reme edit ...

Parameter	Type	Required	Default	Description
`path`	`string`	yes	—	workspace-relative path
`old`	`string`	yes	—	text to find
`new`	`string`	yes		replacement

Job API Reference ​

System and diagnostics ​

proactive_refresh ​

proactive_read ​

version ​

app_config ​

chat ​

health_check ​

status ​

help ​

list_tags ​

Memory evolution ​

auto_dream ​

auto_memory ​

auto_memory_cc ​

auto_resource ​

Retrieval and graph ​

traverse ​

graph_snapshot ​

reindex ​

search ​

node_search ​

Daily notes ​

daily_list ​

daily_reindex ​

daily_write ​

File operations ​

frontmatter_delete ​

frontmatter_read ​

frontmatter_update ​

stat ​

list ​

move ​

delete ​

read ​

load ​

read_image ​

write ​

save ​

edit ​

Job API Reference

System and diagnostics

`proactive_refresh`

`proactive_read`

`version`

`app_config`

`chat`

`health_check`

`status`

`help`

`list_tags`

Memory evolution

`auto_dream`

`auto_memory`

`auto_memory_cc`

`auto_resource`

Retrieval and graph

`traverse`

`graph_snapshot`

`reindex`

`search`

`node_search`

Daily notes

`daily_list`

`daily_reindex`

`daily_write`

File operations

`frontmatter_delete`

`frontmatter_read`

`frontmatter_update`

`stat`

`list`

`move`

`delete`

`read`

`load`

`read_image`

`write`

`save`

`edit`