kin

<p align="center">
  <img src="https://assets.kitploit.com/production/public/readmes/12665/55686ad4696e166589300e948ce2ed89f45622266654371a433a31c612829ec8.png" alt="Kin、AIエージェントとそれを使って開発する人々のためのコードリポジトリ" width="100%" />
</p>

<h3 align="center">コードのための新しい基盤。</h3>

<p align="center">
  <a href="https://github.com/firelock-ai/kin/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-blue.svg" alt="Apache-2.0" /></a>
  <a href="https://github.com/kinlab-ai/kin/releases/latest"><img src="https://img.shields.io/badge/release-latest-6E56CF.svg" alt="最新リリース" /></a>
</p>

**Kinは、AIエージェントとそれを使って開発する人々のためのグラフネイティブなコードリポジトリです。** ソースコード、記録されたコードの関係性、バージョン管理された履歴をリポジトリの状態として保存します。グラフはリポジトリのモデルそのものであり、別のリポジトリの隣で維持される検索インデックスではありません。

関数、型、そしてそれらの間の関係性は、コミットし、ブランチを切り、マージできるデータです。正確なソースはバイト単位で保持され、ファイルシステムへの投影により、対応ツールは通常のファイルを使い続けることができます。

**パブリックベータ。** よく知っている実際のプロジェクトでKinを試してみてください。粗削りな部分があることを想定してください。

[クイックスタート](#quickstart) · [ドキュメント](https://github.com/firelock-ai/kin/blob/main/docs/quickstart.md) · [ブラウザデモ](https://kinlab.ai/demo)

<p align="center">
  <img src="https://raw.githubusercontent.com/firelock-ai/kin/main/docs/assets/kin-impact-human-bytes.gif" alt="kin impact human_bytes --file crates/kin-cli/src/commands/cache.rs --kind function --depth 1 を実行し、Kin自身のコードベースにおける直接の呼び出し元を、同じ名前に対するgit grep検索の隣に表示している様子" width="100%" />
</p>

スターは他の人がKinを見つける助けになります。質問は[Discussions](https://github.com/kinlab-ai/kin/discussions)で受け付けています。

## つながりを見る

共有関数を変更する前に、他に何を確認すべきでしょうか？Kinを使えば、記録された呼び出し元を調べ、関連するコードを探索できます。CLIとMCPサーバーは同じグラフをクエリするため、あなたとエージェントは同じ記録に基づいて作業できます。

<img src="https://assets.kitploit.com/production/public/readmes/12665/43f73477ba09d6aa7a5bb446cadaea9c36981cc1d093faacaa03b9b61346b955.png" alt="ripgrepに対する記録済みのkin impactクエリで、シグネチャ変更に関連するエンティティを表示している様子" width="100%" />

*`e89fff89ac9af12e8d4ce9d5fd07beb408ca730f`で準備されたripgrepグラフ上で記録されたもの。生の実行アーティファクトは公開されていません。これはワークフローの例であり、パフォーマンスベンチマークではありません。*

## Claude Code、Codex、Cursorから使う

Claude Codeの場合:

```
/plugin marketplace add kinlab-ai/kin
/plugin install kin@kin
```

[Codex](https://github.com/firelock-ai/kin/blob/main/plugins/kin-codex/README.md#install) の場合は、マーケットプレイスを追加してプラグインをインストールするか、`kin setup --intent agent` に MCP サーバーを `~/.codex/config.toml` へ書き込ませてください。

Cursor の場合は、MCP サーバーを手動で追加します。正確なスニペットについては [plugins/kin-cursor](https://github.com/firelock-ai/kin/blob/main/plugins/kin-cursor/README.md#install) を参照してください。

インストール後、よく知っているプロジェクトの新規クローンで `kin init .` を実行してください。残りの手順は `kin-setup` スキルが案内します。

Kin は crates.io では公開されていません。そこにある `kin` クレートは無関係なプロジェクトです。

## クイックスタート

よく知っているプロジェクトの新規かつ完全なクローンで開始してください。`kin init` は Git 履歴を読み取りますが、履歴や追跡対象ファイルを変更することはありません。ストアはチェックアウトの外、`~/.kin/stores` に保持し、リポジトリ内には何も書き込みません。チェックアウトのストアの場所は `kin store path` で表示されます。デフォルトでは、まずチェックアウト中のコミットを取り込むため、そのツリーが読み込まれるとすぐに質問に回答でき、その後バックグラウンドで低優先度により、ブランチとタグから到達可能なすべてのコミットをインポートします。`kin init --history full` は履歴全体を最初にインポートし、`--history none` は履歴を一切インポートしません。履歴のインポートには、チェックアウトのサイズではなく履歴に応じて増大する時間、メモリ、ディスクが必要です。開始前に、`kin init` はメモリと空きディスクを確認し、マシンのリソースが不足していると判断できる場合は数値を示して停止します。**シャロークローンではチェックアウト中のコミットのみが取り込まれ、サブモジュールと Git LFS はサポートされません**。また、Git フック、スパースチェックアウト、未完了のマージやリベースもインポートを停止させます。`kin init` はそれぞれの対処法を示し、新規クローンならそのほとんどを回避できます。

### 1. インストール

macOS、Linux、WSL2 では、1 つのコマンドで Kin をインストールし、検出した AI コーディングツールを接続します。Node.js 20 以降が必要です:

```sh
npx -y @kinlab/kin setup
```

Node のないマシンでは、代わりにインストーラーを実行してください。`get.kinlab.ai` と `get.kinlab.dev` は同じスクリプトを配信しています:

```sh
curl -fsSL https://get.kinlab.dev/install | sh
```

いずれの場合も、インストールによって `kin` が `~/.kin/bin` に配置され、新しいセッション用にそのディレクトリがシェルプロファイルに追加されるため、シェルを別のコマンドとして再読み込みしてください:

```sh
exec "$SHELL" -l
```

ネイティブ Windows x64 では、PowerShell から `irm https://get.kinlab.dev/install.ps1 | iex` でインストールします。
これは `kin` CLI をインストールするもので、AI コーディングツールには接続しません。Windows では WSL2 が
推奨される経路であるためです。[ベータ版の制限](#beta-limits) にある Windows の項目には、
そこで動作する内容が記載されています。ネイティブ Windows ARM64 ビルドは公開されていません。ARM64 マシンでは、
x64 PowerShell からその行を実行してエミュレーション下で x86_64 ビルドをインストールするか、WSL2 を使用してください。
インストーラーは `kin` をユーザー PATH に追加するため、次のステップの前に `exec "$SHELL" -l` の代わりに
新しい PowerShell ウィンドウを開いてください。

その他のインストーラーやトラブルシューティングについては、[完全なクイックスタート](https://github.com/firelock-ai/kin/blob/main/docs/quickstart.md#1-install) を参照してください。

### 2. リポジトリを初期化する

新しいプロンプトで、Kin を使ってリポジトリをクローンします:

```sh
kin clone https://github.com/pallets/itsdangerous
```

既存のものを初期化する場合は、以下のパスを置き換えてください:

```sh
cd /path/to/your/repository &&
kin init . &&
kin overview &&
kin status
```

どちらも、次に実行するコマンドである、そのリポジトリ内の関数に関する `kin refs` の質問で終わります。また、セットアップで許可した場合、Codex CLI と Grok CLI もそれに接続します。これらのクライアントはリポジトリを指定するエントリを1つ保持するためです。

Windows PowerShell 5.1 には `&&` がないため、ネイティブ Windows では同じコマンドを1つずつ実行し、失敗したら停止してください:

```powershell
cd C:\path\to\your\repository
kin init .
kin overview
kin status
```

`kin overview` は Kin がインポートしたエンティティを表示します。`kin status` は何が受け入れられたか、およびそれに対する作業ツリーの状態を表示します。`kin graph status` はデーモンのライブクエリグラフとカバレッジを報告します。未コミットおよび未追跡の変更はインポートされた Git 履歴の一部ではありません。`kin init` は何を除外したかを報告します。

### 3. 検証可能な質問をする

コード内に存在することが既に分かっているものを探します:

```sh
kin locate "<something you already know is in this repository>"
```

以下の `ExactEntityName` を結果のシンボルに置き換えてください:

```sh
kin refs ExactEntityName
kin trace ExactEntityName
kin impact ExactEntityName
```

`refs` は記録された参照を返し、`trace` は近傍のコンテキストを取り込み、`impact` はグラフを通じて潜在的な影響を探索します。結果はソースと照合してください。

### 4. AI コーディングツールとセマンティック検索

`kin setup` は検出した AI コーディングツールに接続する前にすでに確認を行い、同意した場合は接続しています。別途リンク手順はありません。別のツールをインストールした後は、再度 `kin setup` を実行してください。`kin setup status` で接続状況を確認できます。Windows では、WSL2 内で AI ツールを接続してください。

`kin runtime status --json` は、共有 CLI とデーモンのインストール状況を、正確なソース識別情報を含めて確認します。通常のコマンドは不一致のペアを拒否します。開発ビルドは分離された状態を使用します。詳細は [runtime installation](https://github.com/firelock-ai/kin/blob/main/docs/runtime-installation.md) を参照してください。

グラフ検索と語彙検索はモデルなしで動作します。埋め込みとリランキングはオプションであり、そのモデルプロバイダーのデフォルトは `none` です。標準の CLI およびデーモンビルドには外部 HTTP モデルのサポートが含まれています。組み込みモデルを利用するには、オプションのローカル推論を有効にしたビルドが必要です。

自身で運用する OpenAI 互換エンドポイントを使用して埋め込みインデックスを構築するには:

```sh
KIN_MODEL_EMBEDDINGS_PROVIDER=external \
KIN_MODEL_EMBEDDINGS_BASE_URL=http://localhost:1234/v1 \
KIN_MODEL_EMBEDDINGS_MODEL=your-served-embedding-model kin embed
```

モデルのエンドポイントは、各ステージに必要な選択済みエンティティテキストを受け取ります。
[モデル設定](https://github.com/firelock-ai/kin/blob/main/docs/env-vars.md)では、プロバイダー、モデル識別子、認証情報の環境変数名について説明しています。

KinはClaude Code、Codex、Cursor、Gemini、その他のMCPクライアントをサポートしています。VS Codeでは`kin setup --intent editor`を使用してください。Kinには、ローカルまたはホスト型のOpenAI互換モデルエンドポイント向けの`kin agent run`も含まれています。

[クライアント設定](https://github.com/firelock-ai/kin/blob/main/docs/readme-reference.md#works-with-your-agent) · [MCPツール](https://github.com/firelock-ai/kin/blob/main/docs/mcp-tools.md) · [組み込みエージェント](https://github.com/firelock-ai/kin/blob/main/docs/cli-reference.md#kin-agent)

ローカルインポート、ストレージ、グラフクエリはお使いのマシン上で実行されます。Kinのインストールにはネットワークアクセスが必要ですが、デフォルトのグラフ取得パスではモデルのダウンロードは不要です。埋め込みプロバイダーを選択した場合、クエリはそのベクトルカバレッジと不足分を報告します。

## 変更をレビューする

レビュー対象のGitブランチで`kin init`を実行した後、明示的なコミットSHAを`main`と比較します:

```sh
kin review shadow "$(git rev-parse main)..$(git rev-parse HEAD)"
```

レポートは `PASS`、`NEEDS ATTENTION`、`WOULD BLOCK` のいずれかを返し、グラフから導出された影響と裏付けとなる証拠を示します。**これは助言的なものです:** マージをブロックしたり、グラフの状態を変更したりすることはありません。 authorship は宣言されたものであり、独立して検証されたものではありません。

## Git あり・なしで Kin を使う

Kin は独自のコミット、ブランチ、マージ、差分、履歴を持ち、下層に Git がないリポジトリでも利用できます。既存の Git リポジトリはインポートでき、サポートされているワークフローでは新しい Git リポジトリをエクスポートできます。

[ネイティブバージョン管理のウォークスルー](https://github.com/firelock-ai/kin/blob/main/docs/readme-reference.md#version-control-without-git) · [Git 相互運用性とエクスポートの制限](https://github.com/firelock-ai/kin/blob/main/docs/readme-reference.md#how-kin-relates-to-git)

## ベータ版の制限

**カバレッジは不完全です。** サポート対象の言語はエンティティと関係性にパースされますが、それ以外のファイルはコンテンツおよび履歴として引き続き利用可能です。空の結果は、呼び出し元や依存関係が存在しないことを証明するものではありません。コンパイラ、テスト、レビューを引き続き使用してください。[言語サポート](https://github.com/firelock-ai/kin/blob/main/docs/language-support.md)を参照してください。

**互換性は一様ではありません。** リリースアーカイブには非推奨の `kin-vfs` ファイルシステムプロジェクションが含まれていないため、依存できる透過的なプロジェクションはありません。各プラットフォームが何をサポートしているかは[プラットフォームに関する注意事項](https://github.com/firelock-ai/kin/blob/main/docs/readme-reference.md#platform-and-maturity)を確認してください。

**Kin 専用の状態をバックアップしてください。** Kin で記録したコミット、ブランチ、レビュー、スペックは Git ではなくリポジトリの Kin ストアに保存されます。ストアを削除して Git から再インポートしてもそれらは復元されないため、まず `kin backup create` を実行してください。同じ理由で、`kin store prune` は `--yes` を渡した場合にのみストアを削除します。[インポート、リカバリ、アップグレードに関する注意事項](https://github.com/firelock-ai/kin/blob/main/docs/readme-reference.md#what-is-real-today-and-what-is-beta)をお読みください。

**Windows。** ネイティブ Windows x86_64 のサポートは初期段階です。リポジトリの受け入れは機能します: `kin init` は Git リポジトリをインポートしてグラフの権限を公開し、グラフ、字句、デーモン経由のクエリはネイティブに応答します。エンドツーエンドのインストール検証では、ネイティブ Windows 上でエージェントのセットアップも実行され、インストールされた MCP サーバーからグラフに基づく回答が得られます。透過的なファイルシステムプロジェクションは Windows では提供されておらず、レビューワークフローもまだそこでテストされていないため、Kin の全機能を利用するには WSL2 が引き続き推奨される方法です。

## Kin を作った理由

コーディングエージェントが、私たちがすでに取り組んだコードベースの一部を寄せ集めているのを何度も目にしてきました。そして、その変更をレビューするために、私自身がその作業の一種をこなしていました。なぜその構造的な理解のより多くがリポジトリ自体の一部になっていないのか、と考えるようになりました。

それが、私が Kin で作っているものです。

Troy

## さらに学ぶ・貢献する

[CLI リファレンス](https://github.com/firelock-ai/kin/blob/main/docs/cli-reference.md) · [アーキテクチャと詳細な制限](https://github.com/firelock-ai/kin/blob/main/docs/readme-reference.md) · [貢献](https://github.com/firelock-ai/kin/blob/main/CONTRIBUTING.md) · [Issues](https://github.com/kinlab-ai/kin/issues/new/choose) · [セキュリティ](https://github.com/firelock-ai/kin/blob/main/SECURITY.md)

Kin とそのローカルスタック（[kin-db](https://github.com/kinlab-ai/kin-db) を含む）は [Apache-2.0](https://github.com/firelock-ai/kin/blob/main/LICENSE) です。[KinLab](https://kinlab.ai) は別個のプロプライエタリなホスト型製品です。公開リポジトリのオンボーディングはまだ開発中です。