Metadata-Version: 2.4
Name: makigumo-cli
Version: 0.1.3
Summary: 黒い画面から美少女に罵られる実用(?)CLIツール
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer>=0.9.0
Requires-Dist: rich>=13.0.0
Requires-Dist: google-genai>=0.2.0
Dynamic: license-file

# 📦 makigumo-cli

「黒い画面から美少女に罵られる」をコンセプトにした、実用（？）AI CLIツールです。

あなたがターミナル（黒い画面）でコマンドを打ち間違えたり、エラーを出したりすると、AI「まきぐも」ちゃんが**ツンデレ・ドSに罵倒しながらも、的確な解決策を教えてくれます。**
さらに、コードのダメ出し（レビュー）、命名の提案、Gitのコミットメッセージ自動生成など、プログラマーの日常をサポート（煽り）する機能が満載です！

---

## 🎯 必要なもの（準備）

このツールを使うには、Googleが提供しているAI「Gemini」のAPIキー（無料）が必要です。

1. **[Google AI Studio](https://aistudio.google.com/)** にGoogleアカウントでログインします。
2. 画面左側の **「Get API key」**（または「APIキーを取得」）をクリックします。
3. **「Create API key」** ボタンを押して、新しいAPIキーを作成し、表示された長い文字列をコピーしておきます。

---

## ⚙️ インストール方法

Python (3.9以上) がインストールされている環境で利用できます。ご自身の環境に合わせてインストール方法を選んでください。

### 方法A: 安全で簡単なインストール (推奨: pipx)
システムを汚さずにCLIツールとしてインストールする一番おすすめの方法です。（あらかじめ `pipx` をインストールしておく必要があります）

```bash
git clone https://github.com/ASDF3001/makigumo-cli.git
cd makigumo-cli
pipx install .
```

### 方法B: 開発・カスタマイズ向け (venv)
ご自身でコードを弄りたい場合は、仮想環境を作ってインストールします。

```bash
git clone https://github.com/ASDF3001/makigumo-cli.git
cd makigumo-cli
python3 -m venv venv
source venv/bin/activate  # Windowsの場合は venv\Scripts\activate
pip install -e .
```

### 方法C: システム破壊覚悟の強行インストール (Linux仮想環境など)
Dockerコンテナ内や、使い捨てのLinux仮想環境など、システムのPython環境が壊れても構わない場合は、制限を突破して直接インストールできます。

```bash
git clone https://github.com/ASDF3001/makigumo-cli.git
cd makigumo-cli
pip install --break-system-packages -e .
```

---

## 🚀 初期設定（APIキーの登録）

インストールが終わったら、ターミナルで以下のコマンドを実行して、準備編でコピーしたAPIキーを登録します。

```bash
makigumo set-key "ここにあなたのAPIキーを貼り付けます"
```
*(環境変数 `GEMINI_API_KEY` を設定することでも代用できます)*

これで準備は完了です！ 🎉

---

## 🎮 遊び方・主なコマンド一覧

ターミナルで `makigumo` と打つと、コマンドの一覧とヘルプが表示されます。

### 実用（開発支援）系
一番のオススメは `run` コマンドです。普段のコマンドの前に `makigumo run` を付けるだけで使えます。

- `makigumo run <コマンド>` : 例: `makigumo run python main.py`。もしエラーが出たらAIが自動解析して罵倒付きで解決策を教えてくれます。
- `makigumo review <ファイル>` : 指定したファイルのコードを読み込ませて、ボロクソにコードレビューされます。
- `makigumo refactor <ファイル>` : 冗長なコードを綺麗に書き直して提案してくれます。
- `makigumo name "〇〇の処理"` : 悩みがちな変数名や関数名の英単語を提案してくれます。
- `makigumo commit` : `git diff` を読み取ってコミットメッセージを自動生成します。
- `makigumo todo` : カレントディレクトリ内の `TODO` / `FIXME` コメントを抽出し、放置状況を煽ってきます。

### エンタメ・雑談系
- `makigumo chat "メッセージ"` : まきぐもちゃんと自由にお話しできます。
- `makigumo mode <default|dos|sweet>` : AIの性格を変更できます。激甘モードやドSモードを搭載。
- `makigumo excuse "進捗ゼロ"` : 上司への言い訳を生成してくれます。
- `makigumo aegi` : 疲れた時に実行すると……？
