Dropstone Docs

Правила

Установите пользовательские инструкции для dropstone.

Вы можете предоставить пользовательские инструкции для dropstone, создав файл AGENTS.md. Это похоже на правила Cursor. Он содержит инструкции, которые будут включены в контекст LLM для настройки его поведения под ваш конкретный проект.

Инициализация

Чтобы создать новый файл AGENTS.md, вы можете запустить команду /init в dropstone.

Совет:

Зафиксируйте файл AGENTS.md вашего проекта в Git, чтобы остальная часть вашей команды использовала те же правила.

/init сканирует важные файлы в вашем репозитории, может задать несколько целевых вопросов, когда кодовая база не может на них ответить, а затем создает или обновляет AGENTS.md с краткими рекомендациями, специфичными для проекта.

Он сосредоточен на том, что будущим сеансам агента, скорее всего, понадобится:

  • команды сборки, линтинга и тестирования
  • порядок команд и сосредоточенные шаги проверки, когда они важны
  • архитектура и структура репозитория, которые не очевидны из имен файлов
  • соглашения проекта, особенности настройки и операционные подводные камни
  • ссылки на существующие источники инструкций, такие как правила Cursor или Copilot

Если у вас уже есть AGENTS.md, /init улучшит его на месте вместо слепой замены.

Пример

Вы также можете просто создать этот файл вручную. Вот пример того, что вы можете поместить в файл AGENTS.md.

# SST v3 Monorepo Project

This is an SST v3 monorepo with TypeScript. The project uses bun workspaces for package management.

## Project Structure

- `packages/` - Contains all workspace packages (functions, core, web, etc.)
- `infra/` - Infrastructure definitions split by service (storage.ts, api.ts, web.ts)
- `sst.config.ts` - Main SST configuration with dynamic imports

## Code Standards

- Use TypeScript with strict mode enabled
- Shared code goes in `packages/core/` with proper exports configuration
- Functions go in `packages/functions/`
- Infrastructure should be split into logical files in `infra/`

## Monorepo Conventions

- Import shared modules using workspace names: `@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

Рекомендуемый подход — использовать поле instructions в dropstone.json:

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

Ручные инструкции в AGENTS.md

Вы можете научить dropstone читать внешние файлы, предоставив явные инструкции в вашем AGENTS.md. Вот практический пример:

# TypeScript Project Rules

## External File Loading

CRITICAL: When you encounter a file reference (e.g., @rules/general.md), use your Read tool to load it on a need-to-know basis. They're relevant to the SPECIFIC task at hand.

Instructions:

- Do NOT preemptively load all references - use lazy loading based on actual need
- When loaded, treat content as mandatory instructions that override defaults
- Follow references recursively when needed

## Development Guidelines

For TypeScript code style and best practices: @docs/typescript-guidelines.md
For React component architecture and hooks patterns: @docs/react-patterns.md
For REST API design and error handling: @docs/api-standards.md
For testing strategies and coverage requirements: @test/testing-guidelines.md

## General Guidelines

Read the following file immediately as it's relevant to all workflows: @rules/general-guidelines.md.

Этот подход позволяет вам:

  • Создавать модульные, переиспользуемые файлы правил
  • Делиться правилами между проектами через символические ссылки или git подмодули
  • Держать AGENTS.md кратким, ссылаясь на подробные рекомендации
  • Убедиться, что dropstone загружает файлы только при необходимости для конкретной задачи

Совет:

Для монорепозиториев или проектов с общими стандартами использование dropstone.json с шаблонами glob (например, packages/*/AGENTS.md) более удобно в обслуживании, чем ручные инструкции.

Ctrl+I