Skip to content

Commit

Permalink
Add instructions for creating a symbolic link for the aish command
Browse files Browse the repository at this point in the history
This commit adds a detailed section to the README.md file that outlines the steps to create a symbolic link for the `aish` command, making it globally executable. The new section includes prerequisites, step-by-step instructions for building the project, using `npm link`, and creating a manual symbolic link if necessary. Additionally, troubleshooting tips are provided for common issues related to command recognition and PATH configuration.
  • Loading branch information
Clear Clown 清楚系ピエロ committed Oct 23, 2024
1 parent eba911a commit 46099b0
Showing 1 changed file with 79 additions and 0 deletions.
79 changes: 79 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,3 +238,82 @@ If you want to help fix a bug or implement a feature in [Issues](https://github.
</picture>
</a>
</p>
以下は、`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`を実行してください。

0 comments on commit 46099b0

Please sign in to comment.