OpenSpec をインストールする

OpenSpec をインストールする

OpenSpec は、提案、仕様、および変更記録を管理します。このページでは、インストール パスを明確に説明して、既存のワークフローに添付できるようにするという 1 つの目標を掲げています。

オープンスペックとは何ですか?

OpenSpec は、ソフトウェア作業における提案と仕様を管理するためのコマンドライン ツールです。中心的なワークフローには次のものが含まれます。

• 提案管理: 機能提案を作成、レビュー、追跡します。
• 仕様の検証: コード変更が事前定義された仕様に準拠していることを確認します。
• 変更追跡: レビューされたすべての変更履歴を記録します
• チーム コラボレーション: 複数人による共同開発をサポートします。

ＨａｇｉＣｏｄｅプロジェクトへの応用

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 のインストール

必要なバージョン

このプロジェクトでは、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

または使用します NVM 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

または使用します NVM 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 インストールが失敗する、または非常に遅い

ネットワーク上の理由により、npm レジストリから OpenSpec をダウンロードできません。

解決策:

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

:::ヒント 中国本土のユーザーは、ダウンロード速度を大幅に向上できるタオバオ ミラーを使用することをお勧めします。 :::

バージョンの互換性の問題

問題: 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. 関連ガイドを参照してください。 ハギコードのドキュメントサイト 追加のヘルプが必要な場合