Dropstone Docs

规则

为 dropstone 设置自定义指令。

您可以通过创建 AGENTS.md 文件为 dropstone 提供自定义指令。这类似于 Cursor 的规则。它包含将被包含在 LLM 上下文中的指令，以针对您的特定项目自定义其行为。

初始化

要创建新的 AGENTS.md 文件，您可以在 dropstone 中运行 /init 命令。

提示:

将您项目的 AGENTS.md 文件提交到 Git，以便团队的其他成员采用相同的规则。

/init 扫描您仓库中的重要文件，当代码库无法回答时可能会提出一些有针对性的问题，然后使用简洁的项目特定指导创建或更新 AGENTS.md。

它专注于未来代理会话最可能需要的内容：

  • 构建、lint 和测试命令
  • 命令顺序和重点验证步骤（如果重要的话）
  • 从文件名不明显的架构和仓库结构
  • 项目特定的约定、设置怪癖和操作陷阱
  • 对现有指令源（如 Cursor 或 Copilot 规则）的引用

如果您已经有 AGENTS.md，/init 将改进它，而不是盲目地替换它。

示例

您也可以手动创建此文件。以下是您可以放入 AGENTS.md 文件的一些内容示例。

# SST v3 单体仓库项目

这是一个使用 TypeScript 的 SST v3 单体仓库。该项目使用 bun workspaces 进行包管理。

## 项目结构

- `packages/` - 包含所有工作区包（functions、core、web 等）
- `infra/` - 按服务分割的基础设施定义（storage.ts、api.ts、web.ts）
- `sst.config.ts` - 主 SST 配置，带有动态导入

## 代码标准

- 使用启用严格模式的 TypeScript
- 共享代码放在 `packages/core/` 中，具有适当的导出配置
- 函数放在 `packages/functions/`
- 基础设施应分为 `infra/` 中的逻辑文件

## 单体仓库约定

- 使用工作区名称导入共享模块：`@my-app/core/example`

我们在这里添加项目特定的指令，这将在您的团队中共享。

类型

dropstone 还支持从多个位置读取 AGENTS.md 文件。这用于不同的目的。

项目

在项目根目录中放置 AGENTS.md 以获取项目特定的规则。这些仅在您在此目录或其子目录中工作时适用。

全局

您也可以在 ~/.config/dropstone/AGENTS.md 文件中拥有全局规则。这适用于所有 dropstone 会话。

由于这不会提交到 Git 或与您的团队共享，我们建议使用它来指定 LLM 应遵循的任何个人规则。

Claude Code 兼容性

对于从 Claude Code 迁移的用户，Dropstone 读取 Claude Code 的文件约定作为后备：

  • 项目规则：项目目录中的 CLAUDE.md（如果不存在 AGENTS.md 则使用）
  • 全局规则：~/.claude/CLAUDE.md（如果不存在 ~/.config/dropstone/AGENTS.md 则使用）
  • 技能：~/.claude/skills/（详见 Skills）

要停止 Dropstone 读取 Claude Code 位置，请删除或重命名这些文件（或将等效内容提交到 AGENTS.md，以便项目优先）。

优先级

当 Dropstone 启动时，它按以下顺序查找规则文件：

  1. 本地文件 通过从当前目录向上遍历（AGENTS.md、CLAUDE.md）
  2. 全局文件 在 ~/.config/dropstone/AGENTS.md
  3. Claude Code 文件 在 ~/.claude/CLAUDE.md（如果上述都不存在）

每个类别中的第一个匹配文件获胜。例如，如果您同时拥有 AGENTS.md 和 CLAUDE.md，则仅使用 AGENTS.md。类似地，~/.config/dropstone/AGENTS.md 优先于 ~/.claude/CLAUDE.md。

自定义指令

您可以在 dropstone.json 或全局 ~/.config/dropstone/dropstone.json 中指定自定义指令文件。这允许您和您的团队重用现有规则，而不必将它们复制到 AGENTS.md。

示例：

{
  "$schema": "https://dropstone.io/schema/config.json",
  "instructions": ["CONTRIBUTING.md", "docs/guidelines.md", ".cursor/rules/*.md"]
}

您也可以使用远程 URL 从网络加载指令。

{
  "$schema": "https://dropstone.io/schema/config.json",
  "instructions": ["https://raw.githubusercontent.com/my-org/shared-rules/main/style.md"]
}

远程指令以 5 秒超时获取。

所有指令文件与您的 AGENTS.md 文件合并。

引用外部文件

虽然 dropstone 不会自动解析 AGENTS.md 中的文件引用，但您可以通过两种方式实现类似的功能：

使用 dropstone.json

推荐的方法是使用 dropstone.json 中的 instructions 字段：

{
  "$schema": "https://dropstone.io/schema/config.json",
  "instructions": ["docs/development-standards.md", "test/testing-guidelines.md", "packages/*/AGENTS.md"]
}

AGENTS.md 中的手动指令

您可以通过在 AGENTS.md 中提供显式指令来教 dropstone 读取外部文件。以下是一个实际示例：

# TypeScript 项目规则

## 外部文件加载

关键：当您遇到文件引用（例如 @rules/general.md）时，使用您的 Read 工具根据需要加载它。它们与特定任务相关。

指令：

- 不要主动加载所有引用 - 根据实际需要使用延迟加载
- 加载后，将内容视为强制指令，覆盖默认值
- 需要时递归跟踪引用

## 开发指南

有关 TypeScript 代码风格和最佳实践：@docs/typescript-guidelines.md
有关 React 组件架构和 hooks 模式：@docs/react-patterns.md
有关 REST API 设计和错误处理：@docs/api-standards.md
有关测试策略和覆盖要求：@test/testing-guidelines.md

## 一般指南

立即读取以下文件，因为它与所有工作流相关：@rules/general-guidelines.md。

这种方法允许您：

  • 创建模块化、可重用的规则文件
  • 通过符号链接或 git 子模块在项目间共享规则
  • 保持 AGENTS.md 简洁，同时引用详细指南
  • 确保 dropstone 仅在特定任务需要时加载文件

提示:

对于单体仓库或具有共享标准的项目，使用带有 glob 模式的 dropstone.json（如 packages/*/AGENTS.md）比手动指令更易维护。

Ctrl+I