Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor command name and update dependencies #129

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
node_modules
.DS_Store
dist
dist
.env
package-lock.json
10 changes: 1 addition & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,11 @@ npm i
Run the `build` script:

```sh
npm build
npm run build
```

The package is bundled using [pkgroll](https://github.com/privatenumber/pkgroll) (Rollup). It infers the entry-points from `package.json` so there are no build configurations.

### Development (watch) mode

During development, you can use the watch flag (`--watch, -w`) to automatically rebuild the package on file changes:

```sh
npm build -w
```

## Running the package locally

Since pkgroll knows the entry-point is a binary (being in `package.json#bin`), it automatically adds the Node.js hashbang to the top of the file, and chmods it so it's executable.
Expand Down
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`を実行してください。
Loading
Loading