diff --git a/README.md b/README.md index c630871..0b28d89 100644 --- a/README.md +++ b/README.md @@ -238,3 +238,82 @@ If you want to help fix a bug or implement a feature in [Issues](https://github.

+ + +以下は、`aish`コマンドのシンボリックリンクを作成し、システム全体で実行可能にするための手順をMarkdown形式でまとめたものです。 + +# `aish` コマンドのシンボリックリンク作成手順 + +## 目的 +このドキュメントでは、`aish` コマンドをグローバルに使用可能にするために、シンボリックリンクを作成する手順を示します。 + +## 前提条件 +- Node.js と npm がインストールされていること。 +- プロジェクトのディレクトリ構成が適切にセットアップされていること(例: `./dist/cli.mjs` が存在すること)。 +- プロジェクトが `npm link` に対応しているか、手動でリンクを作成する。 + +## 手順 + +### 1. プロジェクトのビルド + +まず、プロジェクトのビルドを行います。`npm run build` コマンドを実行して、`./dist/cli.mjs` が生成されることを確認します。 + +```bash +npm run build +``` + +### 2. `npm link` を使用してグローバルにリンク + +`npm link` コマンドを使用してプロジェクトをローカルでグローバルにリンクします。 + +```bash +npm link +``` + +`npm link` によって、`aish` コマンドがシステム全体で使用可能になります。もし`aish`が認識されない場合、次の手順に進んでください。 + +### 3. 手動でシンボリックリンクを作成 + +`npm link` がうまく動作しない場合、手動でシンボリックリンクを作成することができます。次のコマンドを使って、`aish`コマンドを`/usr/local/bin`にリンクします。 + +```bash +sudo ln -s /path/to/your/project/dist/cli.mjs /usr/local/bin/aish +``` + +`/path/to/your/project/`は、プロジェクトのフルパスに置き換えてください。例えば、プロジェクトが`~/Downloads/ai-shell`にある場合、次のように実行します。 + +```bash +sudo ln -s ~/Downloads/ai-shell/dist/cli.mjs /usr/local/bin/aish +``` + +### 4. `aish` コマンドの実行 + +シンボリックリンクが正しく作成されたら、ターミナルから`aish`コマンドを実行できます。 + +```bash +aish +``` + +このコマンドで、`./dist/cli.mjs`が実行されます。 + +--- + +## トラブルシューティング + +- **`aish`コマンドが認識されない場合**: + `npm link` が正しく動作していない場合、手動でシンボリックリンクを作成してください(上記手順を参照)。 + +- **`PATH`に問題がある場合**: + NPMのグローバルインストールディレクトリがシステムの`PATH`に含まれていない可能性があります。以下のコマンドで確認できます。 + + ```bash + npm root -g + ``` + + 返されたパスが`PATH`に含まれているか確認し、含まれていない場合は、`PATH`に追加してください。 + +--- + +## まとめ + +この手順に従って、`aish`コマンドをシステム全体で使用できるように設定します。ビルド後に`npm link`を使うか、手動でシンボリックリンクを作成して`aish`を実行してください。