快速入门¶

安装¶

推荐：通过 uvx 运行（无需本地安装）¶

uvx marrow-core doctor --config /path/to/runtime-config.toml
uvx marrow-core run --config /path/to/runtime-config.toml

本地开发安装¶

git clone https://github.com/zrr1999/marrow-core
cd marrow-core
uv sync --all-groups

使用前提¶

marrow-core 需要一个外部 runtime config（通常由外部 profile 仓库如 marrow-bot 提供）。不要在 marrow-core 仓库内放置 profile 资产。

典型工作流¶

1. 验证配置¶

uvx marrow-core validate --config /path/to/runtime-config.toml

2. 健康检查¶

uvx marrow-core doctor --config /path/to/runtime-config.toml

3. 脚手架初始化工作目录¶

uvx marrow-core scaffold --output-dir ./my-workspace

4. 渲染系统服务定义¶

# 渲染服务描述文件（不自动安装）
uvx marrow-core install \
  --config /path/to/runtime-config.toml \
  --platform auto \
  --output-dir ./service-out

5. 运行调度器¶

# 持续运行
uvx marrow-core run --config /path/to/runtime-config.toml

# 仅执行一轮（调试用）
uvx marrow-core run --once --config /path/to/runtime-config.toml

# 构建 prompt 但不执行（dry run）
uvx marrow-core run --dry-run --config /path/to/runtime-config.toml

文档本地预览¶

本项目使用 zensical 构建文档。

# 安装文档依赖
uv sync --group dev

# 本地预览（http://localhost:8000）
just docs

# 构建静态站点
just docs-build

just docs-build 会把生成的静态站点写入 site/；该目录是构建产物，已加入 .gitignore，不要手动提交。

Vercel 部署¶

Framework Preset: Other
Root Directory: marrow-core
Install Command: uv sync --dev
Build Command: uv run zensical build
Output Directory: site

Vercel 会直接部署 site/ 中的静态内容，因此只需要保留 docs/ 源文件，不需要把生成后的 HTML/CSS/JS 提交到仓库。