Aller au contenu

Installation

Ce guide installe codeknit à partir des sources, l’ajoute à votre PATH, active les complétions de shell et vérifie qu’il fonctionne.

Prérequis

  • Go 1.26 ou ultérieur
  • Un compilateur C. codeknit utilise CGo pour construire ses analyseurs tree-sitter.

Étapes

Fenêtre de terminal
git clone https://github.com/awslabs/codeknit.git
cd codeknit
make build

Le binaire est écrit dans ./bin/codeknit.

Des binaires précompilés pour Linux, macOS et Windows (amd64 et arm64) sont disponibles sur la page des releases. Téléchargez l’archive pour votre plateforme, extrayez-la et déplacez le binaire dans un répertoire de votre PATH. Chaque release inclut un fichier checksums.txt que vous pouvez utiliser pour vérifier le téléchargement.

Ignorez cette section si vous avez déplacé le binaire dans un répertoire déjà présent dans votre PATH, comme /usr/local/bin.

Remplacez /path/to/codeknit par le répertoire contenant le binaire. Si vous avez compilé depuis les sources, il s’agit du répertoire bin à l’intérieur du dépôt cloné.

Ajoutez la ligne correspondant à votre shell dans son fichier de configuration :

Fenêtre de terminal
# bash (~/.bashrc)
export PATH="$PATH:/path/to/codeknit"
# zsh (~/.zshrc)
export PATH="$PATH:/path/to/codeknit"
# fish (~/.config/fish/config.fish)
fish_add_path /path/to/codeknit

Rechargez votre shell ou sourcez le fichier que vous avez édité :

Fenêtre de terminal
source ~/.bashrc # bash
source ~/.zshrc # zsh

Pour fish, ouvrez un nouveau terminal.

codeknit génère des scripts de complétion pour bash, zsh, fish et PowerShell. Exécutez la commande correspondant à votre shell une fois :

Fenêtre de terminal
# bash
codeknit completion bash >> ~/.bashrc
# zsh
codeknit completion zsh >> ~/.zshrc
# fish
codeknit completion fish > ~/.config/fish/completions/codeknit.fish
# PowerShell
codeknit completion powershell >> $PROFILE

Les commandes pour bash, zsh et PowerShell ajoutent le script à votre profil. Les exécuter à nouveau ajouterait le script une seconde fois, donc exécutez chacune d’elles une seule fois.

Ouvrez un nouveau shell ou sourcez votre profil pour activer les complétions.

Fenêtre de terminal
codeknit --version

Si la commande affiche une version, codeknit est installé. Si votre shell rapporte command not found, vérifiez que le répertoire dans votre ligne PATH contient le binaire codeknit, puis rechargez votre shell.

Ne faites cela que si vous prévoyez de contribuer à codeknit. Exécutez ces commandes depuis la racine du dépôt cloné :

Fenêtre de terminal
make deps # installer les dépendances
make setup # configurer les hooks git
make test # exécuter la suite de tests

make lint exécute le linter et le formateur.