インストール
このガイドでは、codeknitをソースからインストールし、PATHに追加し、シェル補完を有効にして、正常に動作するか確認します。
ソースからインストール
Section titled “ソースからインストール”前提条件
- Go 1.26以降
- Cコンパイラ。codeknitはtree-sitterパーサーをビルドするためにCGoを使用します。
手順
git clone https://github.com/awslabs/codeknit.gitcd codeknitmake buildバイナリは./bin/codeknitに書き込まれます。
代わりにプレビルドバイナリを使用する
Section titled “代わりにプレビルドバイナリを使用する”Linux、macOS、Windows(amd64およびarm64)用のプレビルドバイナリはリリースページにあります。プラットフォーム用のアーカイブをダウンロードし、展開して、バイナリをPATH上のディレクトリに移動します。各リリースには、checksums.txtファイルが含まれており、ダウンロードを検証できます。
codeknitをPATHに追加する
Section titled “codeknitをPATHに追加する”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 # bashsource ~/.zshrc # zshfishの場合は、新しいターミナルを開きます。
シェル補完を有効にする
Section titled “シェル補完を有効にする”codeknitはbash、zsh、fish、PowerShell用の補完スクリプトを生成します。該当するシェルのコマンドを一度実行します:
# bashcodeknit completion bash >> ~/.bashrc
# zshcodeknit completion zsh >> ~/.zshrc
# fishcodeknit completion fish > ~/.config/fish/completions/codeknit.fish
# PowerShellcodeknit completion powershell >> $PROFILEbash、zsh、PowerShellのコマンドはプロファイルに追記します。再度実行するとスクリプトが二重に追加されるため、各コマンドは一度だけ実行してください。
新しいシェルを開くか、プロファイルをソースして補完を有効にします。
インストールの確認
Section titled “インストールの確認”codeknit --versionコマンドがバージョンを表示すれば、codeknitはインストールされています。シェルがcommand not foundと報告する場合は、PATH行のディレクトリにcodeknitバイナリが含まれているか確認し、シェルを再読み込みしてください。
開発環境のセットアップ
Section titled “開発環境のセットアップ”これは、codeknitに貢献する予定がある場合にのみ行ってください。クローンしたリポジトリのルートからこれらのコマンドを実行します:
make deps # 依存関係をインストールmake setup # gitフックを設定make test # テストスイートを実行make lintはリンターとフォーマッターを実行します。
次のステップ
Section titled “次のステップ”- はじめにで最初のコマンドを実行。
- CLIフラグリファレンスで全てのフラグを確認。