Job API 参考
本页从 reme/config/default.yaml 自动生成。它描述默认应用中的可调用 Job；插件和自定义配置可以增加、删除或覆盖 Job。运行 reme help 可查看当前服务的实际能力。
后台 Job 和 Cron Job 不通过服务暴露，因此不列入调用参考。
系统与诊断
proactive_refresh
Refresh proactive topics once for local maintenance or debugging; not exposed by HTTP/MCP.
reme proactive_refresh ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
date | string | 否 | 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.
reme proactive_read ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
date | string | 否 | YYYY-MM-DD to read; defaults to today in the dreamer's timezone | |
include_content | boolean | 否 | true | whether to include the raw YAML content in the response answer and metadata |
horizon_days | integer | 否 | 1 | merge interests.yaml across this many recent days (1 = single-day legacy behaviour) |
min_confidence | number | 否 | 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
reme version无参数。
app_config
return the effective application config with secrets redacted
reme app_config无参数。
chat
Stream a read-only agent conversation over the ReMe workspace.
reme chat ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
query | string | 是 | — | user message |
session_id | string | 否 | — | agent session to resume |
system_prompt | string | 否 | — | optional system prompt override |
health_check
return a concise health-check snapshot of reme components
reme health_check无参数。
status
report memory estimates for stateful data components and process RSS
reme status无参数。
help
list all registered jobs with their metadata
reme help无参数。
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].
reme list_tags ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
page | integer | 否 | 1 | 1-based page; values past the end return an empty page |
order_by | string | 否 | tag | sort by tag or file count |
order | string | 否 | — | defaults to asc for tag, desc for file_count |
page_size | integer | 否 | 100 | items per page |
记忆演化
auto_dream
Auto-dream: scan today's day-index and daily notes, globally extract merged units, integrate digest units, and persist the dream catalog.
reme auto_dream ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
date | string | 否 | YYYY-MM-DD to scan; defaults to today in the dreamer's timezone | |
hint | string | 否 | caller guidance passed through to dream extract/integrate | |
scan_days | integer | 否 | 2 | number of recent daily directories to scan, ending at date |
max_units | integer | 否 | 5 | maximum number of extracted memory units |
auto_memory
Auto-memory: record conversation facts into a daily note
reme auto_memory ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
messages | object[] | 是 | — | messages |
session_id | string | 否 | source conversation session identifier | |
memory_hint | string | 否 | — | optional hint |
include_images | boolean | 否 | false | Use session images with a vision-capable AgentScope model; save Base64 originals and cite sources |
date | string | 否 | 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 ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
session_id | string | 是 | — | Claude Code session id; its transcript is resolved from disk |
memory_hint | string | 否 | — | optional hint |
auto_resource
Auto-resource: interpret resource files into daily notes
reme auto_resource ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
include_images | boolean | 否 | true | Process image resource changes with a vision-capable AgentScope wrapper; false skips all image events, including deletes |
changes | object[] | 是 | — | resource change batch, each item has path/file_path and change |
检索与图谱
traverse
Return a bounded wikilink graph with frontend-ready nodes and directed edges.
reme traverse ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
path | string or string[] | 是 | — | workspace-relative path or paths used as graph seeds |
depth | integer | 否 | 1 | maximum number of wikilink hops |
direction | string | 否 | 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_snapshot无参数。
reindex
rebuild BM25, embedding, and/or tag indexes without rescanning workspace files
reme reindex ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
scope | string | 否 | all | — |
search
Hybrid workspace search (vector + BM25, RRF-fused).
reme search ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
query | string | 是 | — | search query |
limit | integer | 否 | 5 | max results |
min_score | number | 否 | 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[] | 否 | [] | optional tags filter; a file matches when it contains at least one valid tag |
start_date | string | 否 | — | optional inclusive start date filter (YYYY-MM-DD); results earlier than this date are excluded |
end_date | string | 否 | — | 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 ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
query | string | 是 | — | search query |
limit | integer | 否 | 20 | max digest nodes to return |
Daily Note
daily_list
List notes under a single day.
reme daily_list ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
date | string | 否 | YYYY-MM-DD; empty = today |
daily_reindex
Rebuild the day-index page daily/<date>.md.
reme daily_reindex ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
date | string | 否 | YYYY-MM-DD; empty = today |
daily_write
Write a daily markdown note with conversation source frontmatter.
reme daily_write ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
name | string | 是 | — | daily note filename stem and frontmatter name |
description | string | 是 | — | frontmatter description |
session_id | string | 是 | — | source conversation session identifier |
content | string | 是 | — | body |
date | string | 否 | YYYY-MM-DD daily note date; empty = today | |
metadata | object | 否 | — | Optional extra frontmatter fields. |
文件操作
frontmatter_delete
Drop keys from a file's frontmatter.
reme frontmatter_delete ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
path | string | 是 | — | workspace-relative path |
keys | string[] | 是 | — | keys to remove |
frontmatter_read
Read a file's frontmatter as a dict.
reme frontmatter_read ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
path | string | 是 | — | workspace-relative path |
frontmatter_update
Merge key-value pairs into a Markdown file's frontmatter while preserving its body and unrelated fields.
reme frontmatter_update ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
path | string | 是 | — | workspace-relative path |
metadata | object | 是 | — | key-values to merge |
stat
Stat path (size, mtime, exists, is_dir, is_file).
reme stat ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
path | string | 是 | — | workspace-relative path |
list
List files under a workspace path.
reme list ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
path | string | 否 | workspace-relative dir; empty = root | |
recursive | boolean | 否 | false | recurse |
sort_by | string | 否 | — | optional ordering; mtime returns most recently modified files first |
extensions | string[] | 否 | — | optional extension allowlist applied before sorting and limiting |
limit | integer | 否 | 100 | max results |
move
Move / rename a workspace file; rewrites inbound wikilinks by default.
reme move ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
src_path | string | 是 | — | workspace-relative source |
dst_path | string | 是 | — | workspace-relative destination |
overwrite | boolean | 否 | false | overwrite if dst exists |
retarget | boolean | 否 | true | rewrite [[src]] → [[dst]] across the workspace |
delete
Delete a workspace file or folder; returns surviving inbound wikilinks.
reme delete ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
path | string | 是 | — | workspace-relative path |
read
Read a markdown file under the workspace.
reme read ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
path | string | 是 | — | workspace-relative path; markdown only |
start_line | integer | 否 | — | first line (1-based, inclusive) |
end_line | integer | 否 | — | last line (1-based, inclusive) |
load
Load a complete text file for the local editor without agent-output truncation.
reme load ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
path | string | 是 | — | workspace-relative path |
read_image
Read an image file as base64 (workspace-relative path).
reme read_image ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
path | string | 是 | — | 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 ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
path | string | 是 | — | workspace-relative path; markdown only |
name | string | 是 | — | frontmatter name |
description | string | 是 | — | frontmatter description |
content | string | 是 | — | body |
metadata | object | 否 | — | Optional extra frontmatter fields (md only). |
save
Save text verbatim, optionally rejecting external changes since the file was opened.
reme save ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
path | string | 是 | — | workspace-relative path |
content | string | 是 | — | complete file content, including frontmatter |
expected_mtime | string | 否 | — | optional ISO mtime returned by stat |
edit
Find-and-replace in a markdown file (all occurrences).
reme edit ...| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
path | string | 是 | — | workspace-relative path |
old | string | 是 | — | text to find |
new | string | 是 | replacement |