Installer OpenSpec

Installer OpenSpec

OpenSpec gère les propositions, les spécifications et les enregistrements de modifications. Cette page n’a qu’un seul objectif : expliquer clairement le chemin d’installation afin que vous puissiez le joindre à votre flux de travail existant.

Qu’est-ce qu’OpenSpec ?

OpenSpec est un outil en ligne de commande permettant de gérer les propositions et les spécifications dans le cadre du travail logiciel. Le flux de travail principal comprend :

• Gestion des propositions : créez, examinez et suivez les propositions de fonctionnalités
• Validation des spécifications : assurez-vous que les modifications du code sont conformes aux spécifications prédéfinies
• Suivi des modifications : enregistrez tout l’historique des modifications examiné
• Collaboration en équipe : prend en charge le développement collaboratif de plusieurs personnes

Application dans les projets HagiCode

Dans les projets HagiCode, OpenSpec est utilisé pour :

1. Gestion du développement de fonctionnalités : toutes les nouvelles fonctionnalités doivent passer par le processus de proposition OpenSpec
2. Révision du code : garantir que les modifications sont conformes aux spécifications du projet
3. Synchronisation de la documentation : maintenir la cohérence entre la documentation et l’implémentation du code
4. Intégration du contrôle de version : intégration transparente avec les flux de travail de contrôle de version

Conditions préalables

Avant d’installer OpenSpec, assurez-vous que votre système répond aux exigences suivantes :

Node.js et npm

OpenSpec est distribué via npm et nécessite un environnement Node.js. OpenSpec nécessite Node.js 18.0 ou supérieur.

Vérifiez l’installation de Node.js :

node --version

Vérifiez l’installation de npm :

npm --version

S’il n’est pas installé ou si la version est trop ancienne, veuillez vous référer aux instructions d’installation du logiciel correspondant dans le Guide d’installation.

Installation d’OpenSpec

Exigences de la version

Ce projet nécessite l’utilisation de la gamme de versions OpenSpec 1.0.0 ou supérieure. Toutes les versions 1.x sont prises en charge pour garantir la compatibilité avec le flux de travail du projet.

OpenSpec est installé globalement via npm, le rendant disponible depuis n’importe où sur votre système.

Installer globalement à l’aide de npm

Windows

Exécuter dans PowerShell ou dans une invite de commande :

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

Problèmes d’autorisation Windows

Si vous rencontrez des erreurs d’autorisation lors de l’installation, exécutez PowerShell ou l’invite de commande en tant qu’administrateur.

macOS

Exécuter dans le terminal :

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

Problèmes d’autorisation macOS

Si vous rencontrez EACCES erreurs d’autorisation, essayez :

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

Ou utiliser nvm pour gérer les versions de Node.js et éviter les problèmes d’autorisation.

Linux

Exécuter dans le terminal :

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

Problèmes d’autorisation Linux

Si vous rencontrez EACCES erreurs d’autorisation, vous pouvez :

1. Utiliser sudo: sudo npm install -g @fission-ai/openspec@1
2. Configurez npm pour utiliser le répertoire utilisateur :

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

Vérifier l’installation

Après l’installation, vérifiez qu’OpenSpec est installé correctement et que la version répond aux exigences :

openspec --version

Si l’installation est réussie, vous verrez un numéro de version s’afficher, par exemple :

openspec/1.1.1 linux-x64 node-v18.17.0

Plage de versions

Veuillez vous assurer que la version OpenSpec installée est 1.0.0 ou supérieure. Le projet a vérifié la compatibilité avec la version 1.1.1. Il est recommandé d’utiliser la dernière version compatible pour bénéficier de nouvelles fonctionnalités.

Problèmes courants et dépannage

Erreurs d’autorisation

Problème : EACCES Autorisation refusée

Rencontre d’erreurs d’autorisation lors de l’installation ou de l’exécution d’OpenSpec.

Solutions :

Windows

Exécutez PowerShell ou l’invite de commande en tant qu’administrateur :

1. Cliquez avec le bouton droit sur PowerShell ou Invite de commandes
2. Sélectionnez “Exécuter en tant qu’administrateur”
3. Réexécutez la commande d’installation

macOS

Installer en utilisant sudo:

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

Ou utiliser nvm pour gérer Node.js et éviter les problèmes d’autorisation d’installation globale.

Linux

Solution 1 : utilisez sudo

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

Solution 2 : configurer npm pour utiliser le répertoire des utilisateurs

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

Problèmes de réseau

Problème : l’installation de npm échoue ou est très lente

Impossible de télécharger OpenSpec à partir du registre npm pour des raisons de réseau.

Solutions :

1. Utiliser le miroir npm domestique :

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

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

2. Restaurer la source officielle (si nécessaire) :

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

3. Utilisez cnpm (facultatif) :

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

Il est recommandé aux utilisateurs de Chine continentale d’utiliser le miroir Taobao, qui peut améliorer considérablement la vitesse de téléchargement.

Problèmes de compatibilité des versions

Problème : les commandes OpenSpec s’exécutent anormalement ou signalent des erreurs

La version OpenSpec installée est incompatible avec l’environnement actuel.

Solutions :

1. Vérifiez la version de Node.js :

node --version

Assurez-vous que la version est 18.0 ou supérieure. Si la version est trop basse, veuillez mettre à niveau Node.js.

2. Vérifiez la version OpenSpec :

openspec --version

3. Réinstaller la version spécifique :

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

4. Effacer le cache npm (si le problème persiste) :

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

Commande introuvable

Problème : Saisie openspec La commande affiche « Commande introuvable »

OpenSpec est installé mais le système ne trouve pas la commande.

Solutions :

Windows

1. Confirmez le chemin d’installation global de npm :

npm config get prefix

2. Ajouter le chemin au PATH système :
   • Ouvrez “Propriétés système” → “Avancé” → “Variables d’environnement”
   • Trouver Path dans “Variables système”
   • Ajoutez le chemin global npm (généralement C:\Users\<username>\AppData\Roaming\npm)
   • Redémarrer la fenêtre de ligne de commande

macOS

1. Confirmez le chemin d’installation global de npm :

npm config get prefix

2. Ajouter un chemin à PATH (dans ~/.zshrc ou ~/.bash_profile):

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

3. Recharger la configuration :

source ~/.zshrc

Linux

1. Confirmez le chemin d’installation global de npm :

npm config get prefix

2. Ajouter un chemin à PATH (dans ~/.bashrc):

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

3. Recharger la configuration :

source ~/.bashrc

Mise à niveau d’OpenSpec

Plage de versions

Ce projet nécessite l’utilisation d’OpenSpec 1.0.0 ou d’une version supérieure. Si vous avez des exigences de mise à jour de version, veuillez vous référer à la documentation du projet.

Si vous devez réinstaller une version spécifique :

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

Désinstallation d’OpenSpec

Si vous devez désinstaller OpenSpec :

Windows

npm uninstall -g @fission-ai/openspec

macOS

npm uninstall -g @fission-ai/openspec

Ou utilisez sudo :

sudo npm uninstall -g @fission-ai/openspec

Linux

npm uninstall -g @fission-ai/openspec

Ou utilisez sudo :

sudo npm uninstall -g @fission-ai/openspec

Prochaines étapes

Une fois l’installation d’OpenSpec terminée, vous pouvez continuer avec les étapes suivantes :

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.

Pour des guides d’utilisation OpenSpec plus détaillés, veuillez vous référer au Documentation officielle d’OpenSpec.

Besoin de plus d’aide ?

Si vous rencontrez des problèmes non abordés ici :

1. Vérifier Problèmes OpenSpec GitHub pour des problèmes similaires
2. Visite Documentation officielle d’OpenSpec pour plus d’informations
3. Reportez-vous aux guides connexes sur le Site de documentation HagiCode pour une aide supplémentaire