未翻訳のページは英語で開き、英語と表示されます。
このページは英語の原文の機械翻訳です。内容は英語の原文が優先されます。 Machine-translated from the English page, which is authoritative.
環境変数リファレンス
Loom の設定のほとんどは settings フィールドです。これは server.settings.Settings のフィールドに対応する環境変数 LOOM_<FIELD> で、デフォルト値と意味は自動生成された設定リファレンスに一覧があります。このページでは、それ以外の変数を扱います。具体的には、サーバー、CLI、SDK、プラグイン、コンテナイメージ、compose ファイル、運用スクリプトが os.environ(またはシェルの ${VAR})で直接読み取る変数です。このうち LOOM_* の変数は NON_SETTINGS_ENV(server/settings/_env.py)に、webhook の署名シークレットのようなファミリーの場合は NON_SETTINGS_ENV_PREFIXES に一覧があり、サーバーの未知の変数に対する警告はこれらを対象外とします。tests/unit/test_environment_reference.py は、これらの一覧とこのページを一致させています。
サーバー
| 変数 | 読み取り元 | デフォルト | 意味 |
|---|---|---|---|
OPENAI_API_KEY |
server/embedding/openai.py, server/llm/openai.py |
未設定 | OpenAI の埋め込みモデルと LLM 用のキー。OpenAI のモデルを設定しているのにキーがない場合、埋め込みは ERROR ログを出してフェイクの n-gram 埋め込みにフォールバックし、LLM はフェイクのクライアントにフォールバックし、loom doctor は警告を出します。 |
ANTHROPIC_API_KEY |
server/llm/anthropic.py |
未設定 | Anthropic の LLM プロバイダー用のキー(LOOM_LLM_PROVIDER=anthropic、または claude* モデルから推定)。 |
GEMINI_API_KEY, GOOGLE_API_KEY |
server/embedding/gemini.py |
未設定 | Gemini の埋め込みモデル用のキー。先に設定されている方が使われます。 |
COHERE_API_KEY |
server/core/provider_keys.py |
未設定 | ホスト型リランクプロバイダー用のキー。ない場合、リランカーは警告をログに出し、候補を入力順のまま返します(フェイルオープン)。 |
LOOM_EMBEDDING_API_KEY |
server/core/provider_keys.py |
未設定 | compatible 埋め込みプロバイダー(LOOM_EMBEDDING_PROVIDER=compatible)用のキー。ない場合、/v1/health と loom doctor が欠落として報告します。 |
LOOM_ENV_FILE |
server/core/env_file.py, server/cli/app.py |
.env |
Settings が読む env ファイル、および loom CLI が環境に読み込むファイル。空にすると読み込みません。 |
LOOM_SETTINGS_FILE |
server/core/env_file.py |
未設定(なし) | Settings が env ファイルと環境変数より下の優先度で読む YAML 設定ファイル(設定リファレンス)。指定したファイルが存在しない場合は起動を拒否します。環境変数から読み、なければ env ファイルから読みます。環境変数で空にした場合は、env ファイルの内容にかかわらずファイルを読みません。 |
LOOM_INSTANCE_LABEL |
server/observability/instance.py |
未設定 | すべての台帳行に付く、このプロセスのラベル(最大 64 文字)。これも LOOM_DEPLOYMENT=1(同梱の compose ファイルが設定する設定フィールド)もなしに起動したプロセスは、すべての行の出所を特定できるよう、起動を拒否します。 |
XDG_RUNTIME_DIR |
server/core/runtime_files.py |
未設定 | LOOM_RUNTIME_DIR が未設定のとき、1 つのサーバーの web プロセスが共有ファイル(レート制限テーブル)を置く場所。$XDG_RUNTIME_DIR/loom、/run/loom、/tmp/loom-<uid> のうち、そのユーザーだけが入れるディレクトリであるか、そうできる最初のものが使われます。web プロセスが複数あってどれもない場合、scripts/serve.sh は、自分で数を決めたときは 1 つ起動し、そうでなければ停止して対象を示します。scripts/serve.sh はこの選択を一度だけ行い、LOOM_RUNTIME_DIR としてエクスポートします。 |
HOSTNAME |
server/observability/instance.py |
システムのホスト名 | hostname:pid 形式のインスタンス ID に使うホスト名のフォールバック。 |
POD_NAMESPACE, POD_NAME |
server/core/provider_process.py |
未設定 | この Pod の名前空間と名前(チャートが downward API から設定します)。workers のリーダーは、その名前空間の API にその Pod がもう存在しない、または失敗状態になった時点で、失われた Pod のプロバイダー参加者を退役させます。 |
KUBERNETES_SERVICE_HOST, KUBERNETES_SERVICE_PORT |
server/core/provider_process.py |
Kubernetes が設定 | 失われた Pod の確認が、サービスアカウントのトークンを使って問い合わせる API サーバー。 |
NODE_OPTIONS |
server/code/workers/scip_ts_delta.py, scip_py_delta.py |
未設定 | コンパイラティアのインデクサーのサブプロセスにそのまま渡されます。そのサブプロセスの他の変数はすべてワーカーが設定します。 |
SCIP_ENV_JSON |
server/code/workers/scip_py_delta.py |
未設定 | Python のコンパイラティアのインデクサーにそのまま渡されます。 |
PATH |
server/code/workers/scip_go_delta.py |
継承 | Go ツールチェーンとインデクサーのバイナリの検索に使われます。サブプロセスには専用の PATH が渡されます。 |
LOOM_WEBHOOK_SECRET_<ORG>__<NAME> |
server/core/webhooks.py |
未設定 | Webhook の署名シークレット。メモリ webhook の secret_ref またはタスク受信箱の webhook_secret_ref で名前を指定します。ORG は タスク受信箱の webhook と同じ方式でエンコードした組織 ID です。whsec_ プレフィックスは base64 キーを示し、空白は取り除かれます。未設定の場合、whsec_ の値が空または base64 でない場合、あるいは値が UTF-8 でない場合、そのシークレットは使用できません。メモリ webhook のイベントは待機し(2.5 日後にデッド)、タスク受信箱の通知は保留されます。サーバーは変数名を示して一度だけ警告します。未知の変数の警告は、このプレフィックスを持つすべての名前を対象外にします。 |
プロバイダーの選択そのもの(LOOM_EMBEDDING_MODEL、LOOM_LLM_PROVIDER、LOOM_LLM_MODEL)は設定項目です。デプロイおよび LLM アーキテクチャを参照してください。
コンテナイメージと uvicorn
イメージのコマンドである scripts/serve.sh がこれらを読み取り、uvicorn を起動します。scripts/serve.sh は環境変数のみから値を取得し、.env や LOOM_ENV_FILE からは取得しません(compose の env_file: は値を環境変数に設定します)。ただし設定フィールドの LOOM_WEB_WORKERS、LOOM_TRUSTED_PROXIES、LOOM_RUNTIME_DIR は例外で、サーバーが読み込む際に、環境変数、env ファイル、設定ファイルの順に解決されます。uvicorn 自身の UVICORN_<OPTION> 変数は読み取られません。scripts/serve.sh が渡さない uvicorn のオプションに対してこの変数が設定されている場合、Web ティアは起動を拒否します。
| 変数 | デフォルト | 意味 |
|---|---|---|
PORT |
7777 |
uvicorn がコンテナ内でバインドするポート。 |
LOOM_LISTEN_HOST |
127.0.0.1 |
uvicorn --host:待ち受けるアドレス。イメージでは 0.0.0.0 に設定されます。LOOM_BIND_HOST は起動時チェックが読み取るアドレスのままで、環境変数に設定がない場合、スクリプトはこれを非ループバックの待ち受けアドレスに設定します(env ファイルや設定ファイルの値は上書きされます)。 |
LOOM_WEB_WORKERS |
CPU ごとに 1、最大 8 | uvicorn --workers。未設定の場合、コンテナが使用できる CPU(cpuset を CPU クォータで下げた値)ごとに 1 つ、メモリ 1 GiB あたり最大 1 つ、かつ最大 8 です。.env でワーカー数を指定していない限り、compose ファイルが設定します。deploy/standalone と開発スタックでは 2、クラウドスタックとカラースタックでは 1 です。設定フィールドでもあり、レートリミッターはこの値で予算を割ります。 |
LOOM_UVICORN_LOOP |
asyncio |
uvicorn --loop:asyncio、auto、uvloop のいずれか。uvloop は git を起動するたびにプロセス全体をフォークするため、ループが停止します。 |
LOOM_TRUSTED_PROXIES |
127.0.0.1 |
uvicorn --forwarded-allow-ips:X-Forwarded-For/-Proto を適用するピア。 |
LOOM_GRACEFUL_SHUTDOWN_S |
10 |
uvicorn --timeout-graceful-shutdown:停止中のプロセスがリクエストを処理しきるまで待つ時間。 |
LOOM_KEEP_ALIVE_S |
5 |
uvicorn --timeout-keep-alive:アイドル状態の接続を開いたままにする時間。接続を再利用するロードバランサーの背後では、そのアイドルタイムアウトより長くしてください。 |
ビルド引数:LOOM_BUILD_COMMIT(イメージに LOOM_BUILD_COMMIT として埋め込まれ、build_commit として報告されます)。イメージには常にローカル CPU エンベッダーとそのデフォルトモデルが含まれ、LOOM_LOCAL_EMBEDDING_MODEL_DIR=/app/models が設定されます。残りの ARG は、コンパイラティアのインデクサー用のツールチェーンのバージョンとチェックサムを固定します(GO_VERSION、NODE_VERSION、SCIP_GO_VERSION、SCIP_CLANG_VERSION、それらの *_SHA256* の値、および LLVM の署名鍵のフィンガープリントである LLVM_SIGNER_FPR)。scripts/install-code-toolchains.sh は、npm でインストールするツール(scip-typescript、scip-python、パッケージマネージャー)のバージョンを固定します。
Compose ファイル
| 変数 | 読み取るもの | デフォルト | 意味 |
|---|---|---|---|
LOOM_CH_HOST_PORT, LOOM_CH_NATIVE_HOST_PORT |
dev/docker-compose.dev.yml, dev/ci_start_clickhouse.sh |
8123, 9000 |
ローカルの ClickHouse が公開するホストポート(HTTP とネイティブ)。 |
LOOM_CH_CONTAINER |
dev/ci_start_clickhouse.sh |
loom-ch |
コンテナ名。これにより、2 つ目の ClickHouse(worktree ごとに 1 つ)を最初のものと並べて実行できます。 |
LOOM_COLOUR, LOOM_COLOUR_PORT |
dev/docker-compose.colour.yml |
必須 | blue/green プロジェクトが実行する色(blue または green)とホストポート(7781 または 7782)。 |
LOOM_CLICKHOUSE_IMAGE |
compose.yaml, dev/ci_start_clickhouse.sh |
clickhouse/clickhouse-server:latest |
スタックが実行する ClickHouse イメージ。リリースバンドルの compose ファイルでは、バンドルのビルドとスキーマ確認に使ったリリースがデフォルトになります。 |
LOOM_IMAGE_REPOSITORY, LOOM_VERSION |
compose.yaml, install.sh |
ghcr.io/clickhouse/loom, latest |
スタンドアロンのスタックが実行するイメージとタグ。インストーラーは .env にタグを固定します。 |
LOOM_EXTRACTOR_IMAGE_REPOSITORY |
compose.yaml, install.sh |
ghcr.io/clickhouse/loom-extractor |
ドキュメント抽出サービスのイメージ。LOOM_VERSION で実行されます。 |
LOOM_PORT |
compose.yaml, install.sh |
7777 |
スタンドアロンのスタックが公開するホストポート。 |
LOOM_REPOSITORY |
install.sh |
ClickHouse/loom |
インストーラーがリリースをダウンロードする GitHub リポジトリ。 |
LOOM_RELEASES_URL |
install.sh |
GitHub | インストーラーがリリースファイルをダウンロードする場所(https:// の URL)。デフォルトは https://github.com/$LOOM_REPOSITORY/releases です。 |
LOOM_CONNECT |
install.sh |
未設定 | 確認なしで接続するコーディングエージェント。claude-code、codex、vscode のカンマ区切りリスト、all、または単独の none。未設定の場合、ターミナルでは確認され、ターミナルのない実行では何も接続されません(クイックスタート)。 |
LOOM_LOCAL_MODELS |
install.sh |
未設定 | ollama を指定すると、確認なしで Loom のモデルジョブ(抽出、および有効化後のアシスタント)がこのマシンの Ollama に設定されます。off は提案を行いません。未設定の場合、ターミナルでの新規インストールでは、実行中の Ollama が提案されます(モデルとキー)。 |
LOOM_NO_OPEN |
install.sh |
未設定 | 1 を指定すると、インストーラーはダッシュボードをブラウザーで開きません。 |
インストーラーに LOOM_VERSION を渡すと、指定したリリースがインストールされます。渡さない場合、リリースの install.sh はそのリリース自身をインストールし、リポジトリのコピーは latest をインストールします。新しいインストールの上に古いリリースをインストールすることは、LOOM_VERSION で指定しない限り拒否されます(先に ClickHouse を固定してください:インストーラーによるインストールのダウングレード)。
compose ファイル内のその他の ${LOOM_*} 参照は、compose レベルのデフォルトが与えられた設定フィールドと、上記の uvicorn 変数です。インストーラーは、2 つのイメージリポジトリ(LOOM_IMAGE_REPOSITORY、LOOM_EXTRACTOR_IMAGE_REPOSITORY)、タグ、ポート、バインドホスト、LOOM_CLICKHOUSE_IMAGE が指定された場合に .env に保持します。標準の .env が設定する内容はクイックスタートを参照してください。
loom CLI
| 変数 | 参照元 | デフォルト | 意味 |
|---|---|---|---|
LOOM_BASE_URL |
server/cli/_client.py とクライアントコマンド |
http://localhost:7777 |
クライアントコマンド(install、demo、export-okf など)が通信するサーバー。 |
LOOM_API_KEY |
server/cli/_client.py とクライアントコマンド |
未設定の場合は ~/.loom/token |
クライアントコマンドが提示するトークン。ここに古い値が残っていると、~/.loom/token よりも優先されます。 |
LOOM_BIND_HOST, LOOM_BIND_PORT |
server/cli/serve.py |
0.0.0.0, 7777 |
loom serve --host と --port のデフォルト値。 |
LOOM_CONFIG_FILE |
server/cli/_client.py |
~/.loom/config.json |
loom doctor --client が読み込むクライアント設定(loom init が書き出すファイル)。 |
LOOM_API_KEY_FILE |
server/cli/_client.py、プラグインの lib/loom-client.mjs、grep shim |
~/.loom/token |
LOOM_API_KEY が未設定のときに読み込まれるトークンファイル。 |
CLI リファレンスを参照してください。
SDKs
| 変数 | 読み取り元 | デフォルト | 意味 |
|---|---|---|---|
LOOM_BASE_URL |
Python および TypeScript SDK | http://localhost:7777 |
コンストラクタでサーバーが指定されていない場合に使うサーバー。 |
LOOM_API_KEY |
Python および TypeScript SDK | loom login のセッション、次に ~/.loom/token |
コンストラクタでベアラートークンが指定されていない場合に使うベアラートークン。空の値は未設定として扱われます。 |
LOOM_PROFILE |
Python および TypeScript SDK | default |
コンストラクタで指定がない場合に、クライアントが使う ~/.loom/credentials 内の loom login セッション。 |
LOOM_LOG_LEVEL |
Python および TypeScript SDK | 未設定 | SDK ロガーのレベル(debug、info、warning/warn、error、off)。 |
LOOM_MENTOR_BRIEF |
Python および TypeScript SDK | off | on にすると、最初の呼び出し時にバックグラウンドで mentor.brief を取得します。 |
LOOM_AUTO_RUN |
Python SDK | off | 各 Agent の存続期間にアンビエントな run を紐付けます。 |
Python SDK と TypeScript SDK を参照してください。
コーディングエージェントのプラグインとフックスクリプト
| 変数 | 読み取り元 | デフォルト | 意味 |
|---|---|---|---|
LOOM_ORG, LOOM_NAMESPACE, LOOM_AGENT |
プラグインの lib/loom-client.mjs、integrations/cursor/、integrations/generic/、dev/loom_init.py |
~/.loom/config.json、次にトークンのクレーム、次に default / coding / クライアント名 |
フックとスクリプトがキャプチャした行を書き込む際に使用する ID。 |
LOOM_HOOK_TIMEOUT_MS |
プラグインの lib/loom-client.mjs |
計測した /v1/health の往復時間の 5 倍(3000 から 8000 の範囲) |
各フックリクエストを中断するタイムアウト。loom doctor --client がこの値を報告します。 |
LOOM_HOOK_EXIT_MS |
プラグインの lib/loom-client.mjs |
LOOM_HOOK_TIMEOUT_MS |
フックプロセスが送信後、終了するまで待機する時間。 |
LOOM_SHUNT_READ_CAP |
プラグインの hooks/loom-code-shunt.mjs |
0(無効) |
インデックス済みで未変更のファイルの範囲指定読み取りが、この行数を超えると、代わりにコードツールへ振り分けられます。 |
Claude Code プラグインを参照してください。
オペレーター用スクリプト
| 変数 | 読み取り元 | デフォルト | 意味 |
|---|---|---|---|
LOOM_REPO |
redeploy.sh |
スクリプトのあるディレクトリ | デプロイ用のチェックアウト。 |
LOOM_REDEPLOY_READY_TIMEOUT_S |
redeploy.sh |
180 |
切り替えを中止するまで、待機側の色の /v1/health が ready を報告するのを待つ時間。 |
LOOM_PUBLIC_HEALTH_URL |
redeploy.sh |
未設定 | 設定すると、クライアントが使用するヘルス URL を最後にプローブする。 |
LOOM_PREFLIGHT_STRICT |
redeploy.sh |
1 |
0 にすると、台帳にのみ存在するマイグレーション行とチェックサムの不一致を、停止ではなくレポートとして扱う。 |
LOOM_PREFLIGHT_HEALTH_URL |
dev/redeploy_preflight.sh |
http://localhost:7777/v1/health |
プリフライトが読み取るヘルス URL。 |
LOOM_PREFLIGHT_PORT |
dev/redeploy_preflight.sh |
7777 |
プリフライトが確認するポート。 |
LOOM_PREFLIGHT_MIGRATE |
dev/redeploy_preflight.sh |
$PYTHON -m server.core.schema.migrate --dry-run |
プリフライトが実行するマイグレーションのドライランコマンド。 |
HDX_BASE, HDX_COOKIE or HDX_EMAIL + HDX_PASSWORD, HDX_DB, HDX_PREFIX, HDX_CONNECTION_ID, DRY_RUN |
deploy/clickstack_sources.sh |
HDX_DB=default, HDX_PREFIX=loom, DRY_RUN=0 |
Loom の ClickStack ソースを登録するための HyperDX インスタンス、認証情報、命名。 |
LOOM_ADMIN_TOKEN |
dev/onboard_tenant.py |
未設定 | テナントをオンボードする管理者トークン。 |
LOOM_OUTPUT_DIR |
dev/loom_init.py, dev/onboard_tenant.py |
. |
オンボーディングスクリプトが出力ファイルを書き込む場所。 |
LOOM_REBUILD_DIR |
scripts/ops/table_rebuild.py, scripts/ops/vector_codec_rebuild.py |
. |
リビルドスクリプトが、実行を停止させる ABORT_REBUILD ファイルを探す場所。また vector_codec_rebuild.py が作成したツインの UUID(<table>_rebuild.uuid)を記録する場所で、ツインが残骸かどうかの判定に使われる。1 回のリビルドのすべての行は、同じディレクトリから実行すること。 |
LANGFUSE_HOST, LANGFUSE_ORG_API_KEY |
dev/loom_init.py |
未設定 | dev/loom_init.py の実行中に行う Langfuse プロジェクトのプロビジョニング。 |
再デプロイの手順とそのプリフライトについては、デプロイとアップグレードを参照してください。コンパイラティアのワーカーについてはコードインデックスの運用、ClickStack についてはClickStackを参照してください。