grepai-quickstart

GrepAI クイックスタート

このスキルでは、5 分で GrepAI を起動し、コードを検索できるようにするまでの手順を詳しく説明します。

このスキルを使う場面

• GrepAI を初めて使うとき
• 基本的なワークフローを手早く確認したいとき
• 新しいプロジェクトに GrepAI をセットアップするとき
• 誰かに GrepAI を紹介するとき

前提条件

• ターミナルにアクセスできること
• インデックスを作成するコードプロジェクトがあること

ステップ 1：GrepAI をインストールする

macOS

brew install yoanbernabeu/tap/grepai

Linux/macOS（代替方法）

curl -sSL https://raw.githubusercontent.com/yoanbernabeu/grepai/main/install.sh | sh

Windows

irm https://raw.githubusercontent.com/yoanbernabeu/grepai/main/install.ps1 | iex

確認：grepai version

ステップ 2：Ollama をインストールする（ローカルエンベディング）

macOS

brew install ollama
ollama serve &
ollama pull nomic-embed-text

Linux

curl -fsSL https://ollama.com/install.sh | sh
ollama serve &
ollama pull nomic-embed-text

確認：curl http://localhost:11434/api/tags

ステップ 3：プロジェクトを初期化する

プロジェクトに移動し、GrepAI を初期化します。

cd /path/to/your/project
grepai init

これにより、デフォルト設定を含む .grepai/config.yaml が作成されます。

• エンベディングプロバイダーとして Ollama を使用
• nomic-embed-text モデル
• GOB ファイルストレージ
• 標準の無視パターン

ステップ 4：インデックス作成を開始する

監視デーモンを起動して、コードのインデックスを作成します。

grepai watch

実行される処理：

1. すべてのソースファイルをスキャンします（.gitignore の設定を尊重します）
2. コードを約 512 トークンのセグメントに分割します
3. Ollama を使ってエンベディングを生成します
4. ベクトルを .grepai/index.gob に保存します

初回のインデックス作成時の出力：

🔍 GrepAI Watch
   Scanning files...
   Found 245 files
   Processing chunks...
   ████████████████████████████████ 100%
   Indexed 1,234 chunks
   Watching for changes...

バックグラウンドモード

長時間実行するプロジェクトの場合：

# Start in background
grepai watch --background

# Check status
grepai watch --status

# Stop when done
grepai watch --stop

ステップ 5：コードを検索する

これで、セマンティック検索ができるようになります。

# Basic search
grepai search "authentication flow"

# Limit results
grepai search "error handling" --limit 5

# JSON output for scripts
grepai search "database queries" --json

出力例

Score: 0.89 | src/auth/middleware.go:15-45
──────────────────────────────────────────
func AuthMiddleware() gin.HandlerFunc {
    return func(c *gin.Context) {
        token := c.GetHeader("Authorization")
        if token == "" {
            c.AbortWithStatus(401)
            return
        }
        // Validate JWT token...
    }
}

Score: 0.82 | src/auth/jwt.go:23-55
──────────────────────────────────────────
func ValidateToken(tokenString string) (*Claims, error) {
    token, err := jwt.Parse(tokenString, func(t *jwt.Token) (interface{}, error) {
        return []byte(secretKey), nil
    })
    // ...
}

ステップ 6：呼び出しグラフを分析する（任意）

関数間の関係をたどります。

# Who calls this function?
grepai trace callers "Login"

# What does this function call?
grepai trace callees "ProcessPayment"

# Full dependency graph
grepai trace graph "ValidateToken" --depth 3

ワークフロー全体のまとめ

# 1. Install (once)
brew install yoanbernabeu/tap/grepai
brew install ollama && ollama serve & && ollama pull nomic-embed-text

# 2. Setup project (once per project)
cd /your/project
grepai init

# 3. Index (run in background)
grepai watch --background

# 4. Search (as needed)
grepai search "your query here"

# 5. Trace (as needed)
grepai trace callers "FunctionName"

コマンド早見表

コマンド	用途
grepai init	プロジェクト設定を初期化
grepai watch	インデックス作成デーモンを起動
grepai watch --background	デーモンをバックグラウンドで実行
grepai watch --status	デーモンの状態を確認
grepai watch --stop	デーモンを停止
grepai search "query"	セマンティック検索
grepai search --json	JSON 出力
grepai trace callers "fn"	呼び出し元を検索
grepai trace callees "fn"	呼び出し先を検索
grepai status	インデックスの統計情報
grepai version	バージョンを表示

検索のヒント

文字どおりの語句ではなく、具体的に説明しましょう。

• ✅ 「ユーザー認証とセッション管理」
• ❌ 「auth」

意図を説明しましょう。

• ✅ 「エラーがコンソールに記録される場所」
• ❌ 「console.error」

英語を使いましょう。

• モデルは主に英語のテキストでトレーニングされています
• 英語のクエリが最も効果的です

次のステップ

基本を習得したら：

1. エンベディングを設定する： grepai-embeddings-* スキルを参照
2. ストレージを設定する： grepai-storage-* スキルを参照
3. 高度な検索： grepai-search-* スキルを参照
4. MCP 統合： grepai-mcp-* スキルを参照

出力形式

クイックスタートが正常に完了した場合：

✅ GrepAI Quickstart Complete

   Project: /path/to/your/project
   Files indexed: 245
   Chunks created: 1,234
   Embedder: Ollama (nomic-embed-text)
   Storage: GOB (local file)

   Try these searches:
   - grepai search "main entry point"
   - grepai search "database connection"
   - grepai search "error handling"