快速开始

安装

在项目根目录执行以下命令：

Linux / macOS / Git Bash：

curl -fsSL https://raw.githubusercontent.com/tower1229/LingXi/main/install/bash.sh | bash

Windows PowerShell：

irm https://raw.githubusercontent.com/tower1229/LingXi/main/install/powershell.ps1 | iex

目录结构

执行远程安装脚本后，你会在项目内得到如下灵犀目录结构：

.cursor/
├── commands/              # 辅助命令入口（init、remember 等）
│   ├── init.md
│   ├── remember.md
│   └── ...
├── skills/                # 执行逻辑（工作流 + 记忆等）
│   ├── task/              # 工作流：task 文档
│   ├── vet/
│   ├── plan/
│   ├── build/
│   ├── review/
│   ├── reviewer-doc-consistency/
│   ├── reviewer-security/
│   ├── reviewer-performance/
│   ├── reviewer-e2e/
│   ├── memory-retrieve/
│   └── ...
├── agents/                # Subagents（独立上下文）
│   └── lingxi-memory-write.md   # 记忆写入
├── hooks/                 # sessionStart 记忆注入约定 + 可选审计/门控
└── .lingxi/
    ├── tasks/                 # 任务文档（统一目录）
    │   ├── 001.task.<标题>.md
    │   ├── 001.plan.<标题>.md
    │   └── ...
    ├── memory/                # 统一记忆系统
    │   ├── INDEX.md           # 统一索引（SSoT）
    │   ├── project/           # 项目级记忆文件（语义+关键词混合检索的主搜索面）
    │   └── share/             # 共享记忆目录（推荐作为 git submodule，跨项目复用）
    └── workspace/             # 工作空间
        └── audit.log          # 审计日志

初始化项目（推荐，可选）

在 Cursor 的 Chat 中输入：

/init

灵犀会引导你完成：

1. 静默理解并校对项目信息 — 优先从现有文档与仓库结构整理技术栈、常用模式、开发规则等，仅在缺失时追问补齐
2. 生成记忆候选清单 — 默认只生成候选，不直接写入
3. 按你的选择可选写入 — 仅当你明确选择 all 或 partial 时，才写入 memory/project/ 或 memory/share/（由 apply 决定）

如果你希望先直接推进具体需求，也可以先使用 /task 创建任务，再按需补做 /init。

第一个任务（推荐）

试试用灵犀创建你的第一个任务：

/task 添加用户登录功能，支持邮箱和手机号登录

灵犀会：

• 自动生成任务编号（如 001）
• 创建结构化的任务文档 .cursor/.lingxi/tasks/001.task.用户登录.md
• 引导你提纯需求、确认技术方案

接下来你可以选择：

下一步	命令	适用场景
审查 task 文档	/vet	希望多角度审查需求文档质量
规划任务	/plan	复杂任务，需要拆分步骤和测试用例
直接构建	/build	简单任务，直接开始写代码

灵犀工作流（Skills）默认作用于当前最新任务，同时也支持多任务用法，详见 核心工作流 - 多任务特性。

下一步

• 了解 核心工作流 的完整生命周期
• 深入理解 记忆系统 的工作原理