Установить OpenSpec

Установить OpenSpec

OpenSpec управляет предложениями, спецификациями и записями изменений. Эта страница преследует одну цель: четко объяснить путь установки, чтобы вы могли прикрепить его к существующему рабочему процессу.

Что такое ОпенСпец?

OpenSpec — это инструмент командной строки для управления предложениями и спецификациями при работе с программным обеспечением. Основной рабочий процесс включает в себя:

• Управление предложениями: создавайте, просматривайте и отслеживайте предложения функций.
• Проверка спецификации: убедитесь, что изменения кода соответствуют заранее заданным спецификациям.
• Отслеживание изменений: записывайте всю проверенную историю изменений.
• Командное сотрудничество: поддержка совместной разработки несколькими людьми.

Применение в проектах HagiCode

В проектах HagiCode OpenSpec используется для:

1. Управление разработкой функций: все новые функции должны пройти процедуру предложения OpenSpec.
2. Проверка кода: убедитесь, что изменения соответствуют спецификациям проекта.
3. Синхронизация документации: поддержание согласованности между документацией и реализацией кода.
4. Интеграция контроля версий: бесшовная интеграция с рабочими процессами контроля версий.

Предварительные условия

Перед установкой OpenSpec убедитесь, что ваша система соответствует следующим требованиям:

Node.js и npm

OpenSpec распространяется через npm и требует среды Node.js. Для OpenSpec требуется Node.js 18.0 или выше.

Проверьте установку Node.js:

node --version

Проверьте установку npm:

npm --version

Если оно не установлено или версия слишком старая, обратитесь к инструкциям по установке соответствующего программного обеспечения в Руководство по установке.

Установка ОпенСпец

Требования к версии

Для этого проекта требуется использование диапазона версий OpenSpec 1.0.0 или выше. Поддерживаются все версии 1.x для обеспечения совместимости с рабочим процессом проекта.

OpenSpec устанавливается глобально через npm, что делает его доступным из любой точки вашей системы.

Установить глобально с помощью npm

Windows

Запустите в PowerShell или командной строке:

npm install -g @fission-ai/openspec@1

Проблемы с разрешениями Windows

Если во время установки вы столкнулись с ошибками разрешений, запустите PowerShell или командную строку от имени администратора.

macOS

Запустить в терминале:

npm install -g @fission-ai/openspec@1

Проблемы с разрешениями macOS

Если вы столкнетесь EACCES ошибки разрешения, попробуйте:

sudo npm install -g @fission-ai/openspec@1

Или используйте НВМ для управления версиями Node.js и предотвращения проблем с разрешениями.

Linux

Запустить в терминале:

npm install -g @fission-ai/openspec@1

Проблемы с разрешениями Linux

Если вы столкнетесь EACCES ошибки разрешения, вы можете:

1. Использование sudo: sudo npm install -g @fission-ai/openspec@1
2. Настройте npm для использования каталога пользователя:

mkdir -p ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc

Проверка установки

После установки убедитесь, что OpenSpec установлен правильно и версия соответствует требованиям:

openspec --version

В случае успешной установки вы увидите вывод номера версии, например:

openspec/1.1.1 linux-x64 node-v18.17.0

Диапазон версий

Убедитесь, что установлена версия OpenSpec 1.0.0 или выше. В проекте проверена совместимость с версией 1.1.1. Для получения новых функций рекомендуется использовать последнюю совместимую версию.

Распространенные проблемы и устранение неполадок

Ошибки разрешений

Проблема: EACCES Разрешение отклонено

Обнаружение ошибок разрешений при установке или запуске OpenSpec.

Решения:

Windows

Запустите PowerShell или командную строку от имени администратора:

1. Щелкните правой кнопкой мыши PowerShell или командную строку.
2. Выберите «Запуск от имени администратора».
3. Повторно запустите команду установки

macOS

Установить с помощью sudo:

sudo npm install -g @fission-ai/openspec@1

Или используйте НВМ для управления Node.js и предотвращения глобальных проблем с разрешениями на установку.

Linux

Решение 1. Используйте sudo

sudo npm install -g @fission-ai/openspec@1

Решение 2. Настройте npm для использования каталога пользователя.

mkdir -p ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
npm install -g @fission-ai/openspec@1

Проблемы с сетью

Проблема: установка npm не удалась или выполняется очень медленно.

Невозможно загрузить OpenSpec из реестра npm по сетевым причинам.

Решения:

1. Использовать внутреннее зеркало npm:

# Use Taobao mirror
npm config set registry https://registry.npmmirror.com

# Then reinstall
npm install -g @fission-ai/openspec@1

2. Восстановить официальный источник (при необходимости):

npm config set registry https://registry.npmjs.org

3. Используйте cnpm (необязательно):

npm install -g cnpm --registry=https://registry.npmmirror.com
cnpm install -g @fission-ai/openspec@1

:::совет Пользователям в материковом Китае рекомендуется использовать зеркало Taobao, которое может значительно повысить скорость загрузки. :::

Проблемы совместимости версий

Проблема: команды OpenSpec выполняются ненормально или сообщают об ошибках

Установленная версия OpenSpec несовместима с текущей средой.

Решения:

1. Проверьте версию Node.js:

node --version

Убедитесь, что установлена версия 18.0 или выше. Если версия слишком низкая, обновите Node.js.

2. Проверьте версию OpenSpec:

openspec --version

3. Переустановить конкретную версию:

npm install -g @fission-ai/openspec@1

4. Очистите кэш npm (если проблема не устранена):

npm cache clean --force
npm install -g @fission-ai/openspec@1

Команда не найдена

Проблема: ввод текста openspec Команда показывает «Команда не найдена»

OpenSpec установлен, но система не может найти команду.

Решения:

Windows

1. Подтвердите глобальный путь установки npm:

npm config get prefix

2. Добавьте путь к системному PATH:
   • Откройте «Свойства системы» → «Дополнительно» → «Переменные среды».
   • Найти Path в “Системные переменные”
   • Добавьте глобальный путь npm (обычно C:\Users\<username>\AppData\Roaming\npm)
   • Перезапустить окно командной строки

macOS

1. Подтвердите глобальный путь установки npm:

npm config get prefix

2. Добавьте путь к PATH (в ~/.zshrc или ~/.bash_profile):

export PATH="$(npm config get prefix)/bin:$PATH"

3. Перезагрузить конфигурацию:

source ~/.zshrc

Linux

1. Подтвердите глобальный путь установки npm:

npm config get prefix

2. Добавьте путь к PATH (в ~/.bashrc):

export PATH="$(npm config get prefix)/bin:$PATH"

3. Перезагрузить конфигурацию:

source ~/.bashrc

Обновление OpenSpec

Диапазон версий

Для этого проекта требуется использование OpenSpec 1.0.0 или более поздней версии. Если у вас есть требования к обновлению версии, обратитесь к документации проекта.

Если вам нужно переустановить определенную версию:

npm install -g @fission-ai/openspec@1

Удаление OpenSpec

Если вам нужно удалить OpenSpec:

Windows

npm uninstall -g @fission-ai/openspec

macOS

npm uninstall -g @fission-ai/openspec

Или используйте sudo:

sudo npm uninstall -g @fission-ai/openspec

Linux

npm uninstall -g @fission-ai/openspec

Или используйте sudo:

sudo npm uninstall -g @fission-ai/openspec

Следующие шаги

После завершения установки OpenSpec вы можете продолжить следующие шаги:

Wizard Setup See how first launch checks OpenSpec and related dependencies, then completes project creation inside the wizard.

Create Proposal Session Learn about the proposal-driven development workflow and transform abstract ideas into structured implementation plans.

:::совет Более подробные руководства по использованию OpenSpec см. Официальная документация OpenSpec. :::

Нужна дополнительная помощь?

Если вы столкнулись с проблемами, не описанными здесь:

1. Проверить Проблемы OpenSpec на GitHub для подобных проблем
2. Посетите Официальная документация OpenSpec для получения дополнительной информации
3. Обратитесь к соответствующим руководствам на Сайт документации HagiCode за дополнительную помощь