ab66f2bb56
* docs: update ReMe documentation URL * docs: localize ReMe Studio social image * docs(AGENTS): update agent guidelines and repository documentation structure - Clarify coding agent guidance for keeping changes small and consistent - Revise project principle descriptions for clarity and modern terminology - Expand repository map with detailed component and folder explanations - Add configuration and CLI usage instructions, including syntax and merging rules - Elaborate on component, step registration, and application lifecycle processes - Define jobs, steps, and state handling conventions for stateless design - Specify workspace and file safety policies, including path restrictions and locking - Update validation commands and testing environment recommendations - Clarify coding and test conventions, including style and dependency policies - Distinguish documentation boundaries and update website content contribution notes - Reinforce change guardrails to avoid breaking backward compatibility and data loss - Improve svg diagram formatting and textual details in auto dream and proactive flow image * style(docs): fix font-family syntax in SVG style definitions - Correct quotation marks around font-family names in memory-as-file.svg - Standardize font-family formatting by removing unnecessary quotes in reme-blog-architecture.svg - Ensure consistent CSS style formatting within SVG files for better rendering fidelity * docs: add ReMe blog to news * style(docs): inline svg styles and improve text formatting - Convert multiline SVG style tags into single-line for compactness in multiple figures - Remove redundant line breaks in subtitle text elements for consistency - Shorten descriptive texts in SVG figures for clarity and conciseness - Adjust font sizes and text for better readability in SVG elements - Correct whitespace issues in Chinese markdown document for improved formatting - Remove unused style blocks from framework structure SVG for cleaner code |
||
|---|---|---|
| .. | ||
| .openai | ||
| app | ||
| build | ||
| db | ||
| drizzle/meta | ||
| examples/d1 | ||
| public | ||
| static | ||
| tests | ||
| worker | ||
| .env.example | ||
| .gitignore | ||
| .prettierignore | ||
| cloudflare-env.d.ts | ||
| drizzle.config.ts | ||
| eslint.config.mjs | ||
| index.html | ||
| next-env.d.ts | ||
| next.config.ts | ||
| package-lock.json | ||
| package.json | ||
| postcss.config.mjs | ||
| README.md | ||
| README_ZH.md | ||
| tsconfig.json | ||
| vite.config.ts | ||
| vite.static.config.ts | ||
ReMe Studio
English | 简体中文
ReMe Studio is the local web workspace for ReMe. It lets you browse and edit user-owned workspace files, explore memory links, and chat with the ReMe Agent without moving durable memory into a separate application database. Search indexes, graphs, and other derived metadata remain rebuildable from the source files.
Features
- Workspace browsing: browse the full workspace or focus on journal and knowledge files through dedicated views. The navigator refreshes as files change on disk.
- Markdown editing and preview: open multiple files in tabs, render Markdown front matter and GitHub Flavored Markdown, edit with Monaco, save with optimistic modification-time checks, and download files locally.
- Memory graph: inspect indexed wikilinks under the
wiki,personal, andprocedureknowledge roots, follow inbound and outbound links, and open the corresponding Markdown source. - Agent chat: stream conversations with the read-only workspace Agent, see tool calls and token usage, and drag workspace files into the conversation as references.
- Service management: inspect service and component memory usage, review the effective redacted configuration and version, and rebuild derived indexes without modifying source memory files.
- Personalization: switch between English and Chinese, and use light, dark, or system appearance.
Requirements
- Node.js 22.13 or newer.
- Python 3.11 or newer with ReMe installed.
- A running ReMe HTTP service. Agent chat additionally requires a working Agent and model configuration.
See the repository README for ReMe installation and backend configuration.
Development
Start ReMe from the repository root, then run the frontend in another terminal:
# Terminal 1, from the repository root
reme start
# Terminal 2
cd website
npm install
npm run dev
Open http://localhost:3000. The frontend connects to
http://127.0.0.1:2333 by default. Override it when needed:
NEXT_PUBLIC_REME_API_URL=http://127.0.0.1:8000 npm run dev
ReMe-hosted static build
ReMe can serve Studio from the same FastAPI process as its HTTP API. Build the static variant and restart ReMe:
cd website
npm ci
npm run build:static
cd ..
reme start
Open http://127.0.0.1:2333. The static build uses same-origin requests by default. For standalone static development,
run npm run dev:static and set
VITE_REME_API_URL to the running ReMe service URL when necessary.
The regular npm run build command remains the vinext/Sites deployment build;
npm run build:static creates dist-static/ exclusively for FastAPI and Python package distribution.
Configuration
The workspace hides dotfiles and dot-directories. It displays only Markdown and text files by default. Configure the
allowed extensions as a comma-separated list in .env.local:
NEXT_PUBLIC_REME_WORKSPACE_EXTENSIONS=md,txt,mdx
The memory graph requires an index built by ReMe. Rebuilding the index from the Studio settings regenerates derived data from workspace files and does not modify the source memory.
Checks
npm run format:check
npm run lint
npm run build
npm run build:static
npm test