Installieren Sie OpenSpec

Installieren Sie OpenSpec

OpenSpec verwaltet Vorschläge, Spezifikationen und Änderungsaufzeichnungen. Diese Seite verfolgt ein Ziel: Erklären Sie den Installationspfad klar, damit Sie ihn in Ihren bestehenden Arbeitsablauf integrieren können.

Was ist OpenSpec?

OpenSpec ist ein Befehlszeilentool zum Verwalten von Vorschlägen und Spezifikationen in der Softwarearbeit. Der Kernworkflow umfasst:

• Vorschlagsverwaltung: Funktionsvorschläge erstellen, überprüfen und verfolgen
• Spezifikationsvalidierung: Stellen Sie sicher, dass Codeänderungen den vordefinierten Spezifikationen entsprechen
• Änderungsverfolgung: Zeichnen Sie den gesamten überprüften Änderungsverlauf auf
• Teamzusammenarbeit: Unterstützen Sie die kollaborative Entwicklung mehrerer Personen

Anwendung in HagiCode-Projekten

In HagiCode-Projekten wird OpenSpec verwendet für:

1. Funktionsentwicklungsmanagement: Alle neuen Funktionen müssen den OpenSpec-Vorschlagsprozess durchlaufen
2. Codeüberprüfung: Stellen Sie sicher, dass Änderungen den Projektspezifikationen entsprechen
3. Dokumentationssynchronisierung: Bewahren Sie die Konsistenz zwischen Dokumentation und Codeimplementierung
4. Integration der Versionskontrolle: Nahtlose Integration mit Versionskontroll-Workflows

Voraussetzungen

Stellen Sie vor der Installation von OpenSpec sicher, dass Ihr System die folgenden Anforderungen erfüllt:

Node.js und npm

OpenSpec wird über npm verteilt und erfordert eine Node.js-Umgebung. OpenSpec erfordert Node.js 18.0 oder höher.

Überprüfen Sie die Node.js-Installation:

node --version

Überprüfen Sie die NPM-Installation:

npm --version

Wenn die Version nicht installiert ist oder zu alt ist, lesen Sie bitte die entsprechenden Installationsanweisungen für die Software im Installationsanleitung.

OpenSpec installieren

Versionsanforderungen

Für dieses Projekt ist die Verwendung des Versionsbereichs OpenSpec 1.0.0 oder höher erforderlich. Alle 1.x-Versionen werden unterstützt, um die Kompatibilität mit dem Projektworkflow sicherzustellen.

OpenSpec wird global über npm installiert und ist somit von überall auf Ihrem System verfügbar.

Global mit npm installieren

Windows

In PowerShell oder Eingabeaufforderung ausführen:

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

Windows-Berechtigungsprobleme

Wenn während der Installation Berechtigungsfehler auftreten, führen Sie PowerShell oder die Eingabeaufforderung als Administrator aus.

macOS

Im Terminal ausführen:

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

macOS-Berechtigungsprobleme

Wenn Sie stoßen EACCES Berechtigungsfehler, versuchen Sie Folgendes:

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

Oder verwenden nvm um Node.js-Versionen zu verwalten und Berechtigungsprobleme zu vermeiden.

Linux

Im Terminal ausführen:

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

Linux-Berechtigungsprobleme

Wenn Sie stoßen EACCES Berechtigungsfehler können Sie:

1. Benutzen sudo: sudo npm install -g @fission-ai/openspec@1
2. Konfigurieren Sie npm für die Verwendung des Benutzerverzeichnisses:

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

Überprüfen Sie die Installation

Überprüfen Sie nach der Installation, ob OpenSpec korrekt installiert ist und die Version den Anforderungen entspricht:

openspec --version

Bei erfolgreicher Installation wird eine Versionsnummer ausgegeben, zum Beispiel:

openspec/1.1.1 linux-x64 node-v18.17.0

Versionsbereich

Bitte stellen Sie sicher, dass die installierte OpenSpec-Version 1.0.0 oder höher ist. Das Projekt hat die Kompatibilität mit Version 1.1.1 überprüft. Es wird empfohlen, die neueste kompatible Version zu verwenden, um neue Funktionen zu erhalten.

Häufige Probleme und Fehlerbehebung

Berechtigungsfehler

Problem: EACCES Erlaubnis verweigert

Beim Installieren oder Ausführen von OpenSpec treten Berechtigungsfehler auf.

Lösungen:

Windows

Führen Sie PowerShell oder die Eingabeaufforderung als Administrator aus:

1. Klicken Sie mit der rechten Maustaste auf PowerShell oder Eingabeaufforderung
2. Wählen Sie „Als Administrator ausführen“
3. Führen Sie den Installationsbefehl erneut aus

macOS

Installieren Sie mit sudo:

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

Oder verwenden nvm um Node.js zu verwalten und Probleme mit globalen Installationsberechtigungen zu vermeiden.

Linux

Lösung 1: Verwenden Sie sudo

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

Lösung 2: Konfigurieren Sie npm für die Verwendung des Benutzerverzeichnisses

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

Netzwerkprobleme

Problem: Die npm-Installation schlägt fehl oder ist sehr langsam

Aus Netzwerkgründen kann OpenSpec nicht aus der NPM-Registrierung heruntergeladen werden.

Lösungen:

1. Inländischen npm Mirror verwenden:

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

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

2. Offizielle Quelle wiederherstellen (falls erforderlich):

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

3. CNPM verwenden (optional):

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

Benutzern auf dem chinesischen Festland wird empfohlen, den Taobao-Spiegel zu verwenden, der die Download-Geschwindigkeit erheblich verbessern kann.

Probleme mit der Versionskompatibilität

Problem: OpenSpec-Befehle werden nicht ordnungsgemäß ausgeführt oder es werden Fehler gemeldet

Die installierte OpenSpec-Version ist nicht mit der aktuellen Umgebung kompatibel.

Lösungen:

1. Node.js-Version überprüfen:

node --version

Stellen Sie sicher, dass die Version 18.0 oder höher ist. Wenn die Version zu niedrig ist, aktualisieren Sie bitte Node.js.

2. OpenSpec-Version prüfen:

openspec --version

3. Bestimmte Version neu installieren:

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

4. Npm-Cache leeren (falls das Problem weiterhin besteht):

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

Befehl nicht gefunden

Problem: Tippen openspec Befehl zeigt „Befehl nicht gefunden“ an

OpenSpec ist installiert, aber das System kann den Befehl nicht finden.

Lösungen:

Windows

1. Bestätigen Sie den globalen Installationspfad von npm:

npm config get prefix

2. Pfad zum Systempfad hinzufügen:
   • Öffnen Sie „Systemeigenschaften“ → „Erweitert“ → „Umgebungsvariablen“
   • Finden Path in „Systemvariablen“
   • Fügen Sie den globalen NPM-Pfad hinzu (normalerweise C:\Users\<username>\AppData\Roaming\npm)
   • Starten Sie das Befehlszeilenfenster neu

macOS

1. Bestätigen Sie den globalen Installationspfad von npm:

npm config get prefix

2. Pfad zu PATH hinzufügen (in ~/.zshrc oder ~/.bash_profile):

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

3. Konfiguration neu laden:

source ~/.zshrc

Linux

1. Bestätigen Sie den globalen Installationspfad von npm:

npm config get prefix

2. Pfad zu PATH hinzufügen (in ~/.bashrc):

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

3. Konfiguration neu laden:

source ~/.bashrc

OpenSpec aktualisieren

Versionsbereich

Für dieses Projekt ist die Verwendung von OpenSpec 1.0.0 oder einem höheren Versionsbereich erforderlich. Wenn Sie Anforderungen an eine Versionsaktualisierung haben, lesen Sie bitte die Projektdokumentation.

Wenn Sie eine bestimmte Version neu installieren müssen:

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

OpenSpec deinstallieren

Wenn Sie OpenSpec deinstallieren müssen:

Windows

npm uninstall -g @fission-ai/openspec

macOS

npm uninstall -g @fission-ai/openspec

Oder verwenden Sie sudo:

sudo npm uninstall -g @fission-ai/openspec

Linux

npm uninstall -g @fission-ai/openspec

Oder verwenden Sie sudo:

sudo npm uninstall -g @fission-ai/openspec

Nächste Schritte

Nachdem die OpenSpec-Installation abgeschlossen ist, können Sie mit den folgenden Schritten fortfahren:

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.

Ausführlichere OpenSpec-Nutzungshandbücher finden Sie im Offizielle OpenSpec-Dokumentation.

Benötigen Sie weitere Hilfe?

Wenn Sie auf Probleme stoßen, die hier nicht behandelt werden:

1. Überprüfen OpenSpec GitHub-Probleme für ähnliche Probleme
2. Besuchen Sie Offizielle OpenSpec-Dokumentation für weitere Informationen
3. Weitere Informationen finden Sie in den entsprechenden Anleitungen HagiCode-Dokumentationsseite für zusätzliche Hilfe