コンテンツにスキップ

インストール

このガイドでは、codeknitをソースからインストールし、PATHに追加し、シェル補完を有効にして、正常に動作するか確認します。

前提条件

  • Go 1.26以降
  • Cコンパイラ。codeknitはtree-sitterパーサーをビルドするためにCGoを使用します。

手順

ターミナルウィンドウ
git clone https://github.com/awslabs/codeknit.git
cd codeknit
make build

バイナリは./bin/codeknitに書き込まれます。

代わりにプレビルドバイナリを使用する

Section titled “代わりにプレビルドバイナリを使用する”

Linux、macOS、Windows(amd64およびarm64)用のプレビルドバイナリはリリースページにあります。プラットフォーム用のアーカイブをダウンロードし、展開して、バイナリをPATH上のディレクトリに移動します。各リリースには、checksums.txtファイルが含まれており、ダウンロードを検証できます。

PATH上のディレクトリ(例:/usr/local/bin)にバイナリを移動した場合は、このセクションをスキップしてください。

/path/to/codeknitをバイナリが含まれるディレクトリに置き換えてください。ソースからビルドした場合は、クローンしたリポジトリ内のbinディレクトリです。

シェルの設定ファイルに、該当するシェルの行を追加します:

ターミナルウィンドウ
# 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

シェルを再読み込みするか、編集したファイルをソースします:

ターミナルウィンドウ
source ~/.bashrc # bash
source ~/.zshrc # zsh

fishの場合は、新しいターミナルを開きます。

codeknitはbash、zsh、fish、PowerShell用の補完スクリプトを生成します。該当するシェルのコマンドを一度実行します:

ターミナルウィンドウ
# bash
codeknit completion bash >> ~/.bashrc
# zsh
codeknit completion zsh >> ~/.zshrc
# fish
codeknit completion fish > ~/.config/fish/completions/codeknit.fish
# PowerShell
codeknit completion powershell >> $PROFILE

bash、zsh、PowerShellのコマンドはプロファイルに追記します。再度実行するとスクリプトが二重に追加されるため、各コマンドは一度だけ実行してください。

新しいシェルを開くか、プロファイルをソースして補完を有効にします。

ターミナルウィンドウ
codeknit --version

コマンドがバージョンを表示すれば、codeknitはインストールされています。シェルがcommand not foundと報告する場合は、PATH行のディレクトリにcodeknitバイナリが含まれているか確認し、シェルを再読み込みしてください。

これは、codeknitに貢献する予定がある場合にのみ行ってください。クローンしたリポジトリのルートからこれらのコマンドを実行します:

ターミナルウィンドウ
make deps # 依存関係をインストール
make setup # gitフックを設定
make test # テストスイートを実行

make lintはリンターとフォーマッターを実行します。