ReMe/docs/en/faq.md
imrewce 354837f9af
feat(proactive): separate proactive refresh from auto dream (#488)
* refractor(proactive): upgrade proactive feature with disentangled job and steps

* refactor(proactive): apply audit fixes

- rename read-side job 'proactive' -> 'proactive_read' (less confusing vs the refresh pipeline)
- drop dedicated agent_wrapper.proactive; extraction reuses the default wrapper
- simplify schema: remove unused ProactiveExtractOutput/TopicUpdate, drop resource_paths
- extract no longer scans resource/ directly (daily notes already carry resource content)
- update tests and docs accordingly

* feat(proactive): strict extract-output gate and prompt total budget

- parse_extract_reply now requires a contract section (follow_ups/extends/updates
  as a list); non-empty replies with misspelled section names trigger the
  existing one-shot retry instead of silently checkpointing changed files
- pack_paths gains max_total_chars; extract packs newest daily material first,
  keeps the first file on overflow, and records omitted files in a trailer
  (default budget 300000 chars, configurable via max_total_chars)
- tests: schema gate unit, schema-error retry e2e, budget unit + e2e

* feat(proactive): add scenario-card plan step and generative agenda step

* feat(proactive): digest-personal profile personalization and leaner LLM contract

- extract/plan/agenda now draw a user profile block from <digest_dir>/personal/*.md
  (frontmatter description + body excerpt, per-file budget, profile.md fallback)
- all daily access honours the configured daily_dir (prompt paths parameterized,
  config-driven fallbacks) so workspaces using e.g. memory/ work unchanged
- schema trim: drop dead fields errors/material_paths, carry_forward_all -> count
- shrink LLM output contract: new topics emit title/reason/confidence/paths only;
  keywords removed end-to-end, evidence derived from paths[0] (updates keep it)

* fix(proactive): skip checkpoint when extract reply stays unusable after retry

Two consecutive unparseable replies now short-circuit the round without
checkpointing, so the same material is retried next round instead of being
silently consumed (closes the residual audit #1 gap: the structural gate
detected schema-wrong output but a double failure still checkpointed).

* fix(proactive): replace running bool with reference-counted job activity tracker for the idle gate

* refactor(proactive): remove job activity tracking and idle gate, restore job tree to upstream

* fix(proactive): address second audit round (readonly reader, mtime checkpoint, wider fallbacks, profile containment, horizon content, expiry boundary)

* refactor(dream): strip interests.yaml ownership from dream, proactive is now the sole writer

* refactor(dream): separate proactive topic generation

* ci: update renamed auto dream smoke test

* fix(proactive): complete refresh migration and docs

---------

Co-authored-by: jinli.yl <jinli.yl@alibaba-inc.com>
2026-09-07 17:23:37 +08:00

2.7 KiB

title description
Frequently Asked Questions Quick answers for ReMe installation, services, models, retrieval, files, and plugins.

Frequently Asked Questions

Do basic file operations require a model API key?

No. write, read, list, stat, BM25 search, wikilink traversal, and proactive_read work without model credentials. auto_memory, auto_resource, auto_dream, and proactive refresh require an LLM.

Why is search still BM25-only after setting an embedding key?

Embeddings are disabled by default. Configure as_embedding and embedding_store, then connect file_store.default.embedding_store to that component. See Configuration.

Why did reme reindex not discover a new file?

reindex rebuilds indexes from current file_chunks; it does not scan the workspace. Check index_update_loop, the watched directory and extension, and health_check.

How do I use another workspace?

reme start workspace_dir=/absolute/path/to/memory

Ordinary CLI calls discover the running service, so they do not need the workspace argument again.

What if port 2333 is occupied?

Do not stop an unknown listener. Select another port:

reme start service.port=8181

Then confirm it with reme find_reme.

Why is an installed plugin missing its Jobs?

Installation only makes the distribution discoverable in the active Python environment. Enable it for the Application:

reme start plugins='["auto-fin"]'

Restart a running service after changing package or enablement state.

May I edit workspace Markdown directly?

Yes. Files are the source of truth and watchers ingest changes. Keep frontmatter valid, use complete workspace-relative wikilinks, and avoid unconditional concurrent saves.

May I expose ReMe publicly?

Not with the default configuration alone. Jobs can write and delete, HTTP CORS is permissive, and there is no general authentication layer. Use a controlled network or authenticated TLS reverse proxy and restrict service.jobs.

How should I back up and migrate memory?

Stop writes and back up the complete workspace. session/, resource/, daily/, and digest/ are the key sources; metadata/ can be backed up or rebuilt. See Diagnostics, Backup, and Recovery.

Why is Studio unavailable?

The base reme-ai package has no frontend assets. Install reme-ai[web] or reme-ai[core], or set service.web_static_dir. Missing Studio assets do not disable the Job API.

Which capabilities does the running service expose?

reme help
reme app_config

Static documentation describes defaults; plugins and custom configuration may change the active service.