Перейти к содержимому
F●RGEPLAN

forgeplan_export

Создает полный JSON-снимок рабочего пространства: каждого артефакта (PRD, RFC, ADR, Epic, Spec, Note, Problem, Solution, Evidence, Refresh), их метаданных (frontmatter), содержимого в формате Markdown и полного графа связей. Результат может быть записан в файл или возвращен в виде встроенных данных, чтобы агент мог встроить его в ответ, передать в инструменты миграции или прикрепить к аудиторскому следу.

Категория: Рабочее пространство и данные

Когда агент вызывает эту функцию

Заголовок раздела «Когда агент вызывает эту функцию»
  • Резервное копирование перед рискованной операцией, такой как повторная инициализация forgeplan init, обновление схемы или массовое удаление - главная защита от потери артефактов.
  • Передача между машинами - передайте зашифрованный JSON-объект на машину другого разработчика и восстановите его с помощью forgeplan_import.
  • Заполнение CI - сделайте снимок эталонного рабочего пространства один раз и загружайте его в каждый запуск конвейера детерминированно.
  • Аудит / соответствие - зафиксируйте состояние решений на границе релиза для отслеживаемости.
  • Отладка самого ForgePlan - прикрепите экспорт к отчету об ошибке, чтобы сопровождающие могли воспроизвести точное состояние рабочего пространства.

Примечания по безопасности

Заголовок раздела «Примечания по безопасности»
  • Экспорт доступен только для чтения. Он никогда не изменяет рабочее пространство.
  • Ключи API и локальная конфигурация НЕ экспортируются. Файл .forgeplan/config.yaml игнорируется Git и находится вне домена артефактов; экспорт содержит только артефакты + связи. Вам все равно потребуется перенастроить провайдеров LLM после forgeplan_import.
  • Производные индексы (.forgeplan/lance/, .fastembed_cache/) не включаются - они перестраиваются по требованию с помощью forgeplan scan-import.
  • Экспорт является каноническим форматом резервного копирования. Никогда не выполняйте rm -rf .forgeplan, не вызвав сначала forgeplan_export.

Входные параметры

Заголовок раздела «Входные параметры»
ИмяТипОбязательныйОписание
outputstringnoПуть к целевому файлу. Если опущено, инструмент возвращает JSON-пакет в виде встроенных данных в ответе. Если указано, инструмент записывает данные на диск и возвращает краткое сообщение об успешном выполнении.

Источник схемы: crates/forgeplan-mcp/src/server.rs::ExportParams

Возвращает

Заголовок раздела «Возвращает»

С output:

{
  "written": "/Users/me/forgeplan-backup-2026-04-11.json",
  "artifacts": 187,
  "relations": 312,
  "bytes": 648321
}

Без output (встроенный режим):

{
  "version": 1,
  "generated_at": "2026-04-11T12:04:18Z",
  "artifacts": [
    {
      "id": "PRD-001",
      "kind": "prd",
      "status": "active",
      "depth": "standard",
      "title": "Auth system",
      "body": "# PRD-001: Auth system\n\n## Problem\n…",
      "tags": ["auth"],
      "valid_until": null,
      "updated_at": "2026-04-08T10:00:00Z"
    }
  ],
  "relations": [
    { "from": "EVID-012", "to": "PRD-001", "type": "informs" }
  ]
}

Встроенный режим удобен для небольших рабочих пространств; для больших предпочтительнее запись в файл, чтобы избежать раздувания полезной нагрузки ответов MCP.

Пример вызова

Заголовок раздела «Пример вызова»

Запись в файл (рекомендуется для резервного копирования):

{ "output": "/tmp/forgeplan-backup-2026-04-11.json" }

Возврат встроенных данных (для программного использования):

{}

Типичная последовательность

Заголовок раздела «Типичная последовательность»
forgeplan_export (output=backup.json)       ← safety snapshot
…perform risky operation…
forgeplan_import (data=<contents of backup.json>)   ← restore if things go wrong

Для миграции:

[machine A] forgeplan_export → bundle.json
[transfer bundle.json]
[machine B] forgeplan init → forgeplan_import (data=bundle.json)

Эквивалент CLI

Заголовок раздела «Эквивалент CLI»
  • forgeplan export - идентичное поведение из терминала.

См. также

Заголовок раздела «См. также»