クイックスタート
Takumi Guard は、悪意あるパッケージが開発環境に到達する前にブロックします。npm、PyPI、RubyGems の透過プロキシとして動作し、コード変更は不要です。レジストリの設定を一度行うだけで利用開始できます。
セットアップレベルの選択
Takumi Guard には3つのアクセスレベルがあります。用途に応じてお選びください。
| レベル | 利用可能な機能 | 必要なもの |
|---|---|---|
| 匿名 | 悪意あるパッケージのブロック | レジストリURLの設定のみ |
| メール認証 | ブロック + ダウンロード追跡 + 侵害通知 | メール登録（無料） |
| 組織 | 上記すべて + チーム全体の可視性 | Shisho Cloud アカウント + GitHub Actions |
個人の開発者にはメール認証アクセスをお勧めし ます。1分以内で完了し、侵害通知が無料で利用可能になります。
トークンの種類
Takumi Guard には2種類のトークンがあります。いずれもパッケージマネージャーでの設定方法は同じです。
| トークン | プレフィックス | 発行方法 | 用途 |
|---|---|---|---|
| メール認証トークン | tg_anon_ | メール登録 | 個人の開発環境（Shisho Cloud アカウント不要） |
| 組織ユーザートークン | tg_org_ | コンソールまたは Guard API | 組織全体のインストール追跡 |
- 利用するには、Guard を有効化した Takumi サブスクリプションが必要です。詳しくは料金と請求を参照してください。
- Guard API を用いたトークン発行の活用例は、管理ツールによる一括セットアップを参照してください。
1つのトークンで全エコシステムに対応
いずれの種類のトークンも、1つで Takumi Guard の全エコシステムで利用できます。
- npm — npm、pnpm、yarn、bun
- PyPI — pip、uv、poetry
- RubyGems — Bundler
同じトークンで必要なパッケージマネージャーをいくつでも設定できます。すでに npm をセットアップ済みで PyPI を追加したい場合（またはその逆）、再登録は不要です。同じキーで追加のパッケージマネージャーを設定するだけです。
すでに npm、PyPI、RubyGems のいずれかで登録済みなら、再登録は不要です。お持ちの API キーをそのまま使って、下記のエコシステム別セットアップガイドから追加したいエコシステムを設定してください。
エコシステム別セットアップガイド
保護したいエコシステムのガイドに従ってください。
npm
npm、pnpm、yarn、bun に対応しています。ローカル開発環境の設定、.npmrc の構成、GitHub Actions でのセットアップを含みます。
PyPI
pip、uv、poetry に対応しています。ローカル開発環境の設定、環境変数の構成、GitHub Actions でのセットアップを含みます。
RubyGems
Bundler に対応しています。ローカル開発環境の設定と GitHub Actions でのセットアップを含みます。
クイックリファレンス
すでにトークンをお持ちの方向けの、各パッ ケージマネージャーのワンライナーコマンドです。
npm エコシステム
# npm / pnpm
npm config set registry https://npm.flatt.tech/
npm config set //npm.flatt.tech/:_authToken tg_YOUR_TOKEN
# yarn (v2+) — .yarnrc.yml に追加
npmRegistryServer: "https://npm.flatt.tech/"
npmAuthToken: "tg_YOUR_TOKEN"
# bun — bunfig.toml に追加
[install]
registry = { url = "https://npm.flatt.tech/", token = "tg_YOUR_TOKEN" }
PyPI エコシステム
# pip（ディスクに永続化）
pip config set global.index-url https://token:tg_YOUR_TOKEN@pypi.flatt.tech/simple/
# uv — シェルプロファイルに追加（uv は pip config を参照しません）
export UV_INDEX_URL=https://token:tg_YOUR_TOKEN@pypi.flatt.tech/simple/
# poetry
poetry source add --priority=primary takumi-guard https://pypi.flatt.tech/simple/
poetry config http-basic.takumi-guard token tg_YOUR_TOKEN
RubyGems エコシステム
# Bundler — すべての bundle install コマンドが Guard を経由します
bundle config set --global mirror.https://rubygems.org https://token:tg_YOUR_TOKEN@rubygems.flatt.tech/
セットアップの確認
パッケージマネージャーの設定後、既知のブロック対象パッケージをインストールして Takumi Guard が正常に動作しているか確認できます。
npm install @panda-guard/test-malicious
Takumi Guard が正しく設定されていれば、403 Forbidden エラーでインストールが失敗します。