プロジェクト構成

Documentation Index

Fetch the complete documentation index at: https://docs.arkor.ai/llms.txt

Use this file to discover all available pages before exploring further.

my-arkor-app/
├── src/arkor/
│   ├── index.ts        # createArkor({ trainer })
│   └── trainer.ts      # createTrainer({ ... })
├── arkor.config.ts
├── .arkor/             # プロジェクトごとの状態（gitignore 済み）
└── package.json        # dev / build / start

​

src/arkor/

1. export const arkor = createArkor({ trainer })（推奨。テンプレートが生成する形）。
2. export const trainer = createTrainer({ ... })（パワーユーザー向けショートカット。アンブレラ不要のとき）。
3. デフォルトエクスポート（Arkor マニフェスト or Trainer のいずれか）。

// src/arkor/index.ts（推奨形）
import { createArkor } from "arkor";
import { trainer } from "./trainer";

export const arkor = createArkor({ trainer });

// src/arkor/trainer.ts
import { createTrainer } from "arkor";

export const trainer = createTrainer({
  name: "support-bot-v1",
  model: "unsloth/gemma-4-E4B-it",
  dataset: { type: "huggingface", name: "arkorlab/triage-demo" },
  lora: { r: 16, alpha: 16 },
  maxSteps: 100,
});

​

arkor.config.ts

// arkor.config.ts
export default {};

​

.arkor/（プロジェクトごと、gitignore 済み）

• .arkor/state.json。プロジェクトのルーティング: orgSlug、projectSlug、projectId。これによってランタイムはローカルリポジトリをマネージドバックエンドのワークスペースにマップします。ファイルは ensureProjectState() が作成し、これは初回の学習開始（または初回のベースモデル推論）の際に走ります。匿名ワークスペースではこの初回呼び出しで自動作成されます。OAuth ワークスペースの場合はランタイムがエラーを返します。今のところ arkor login も arkor init もこのファイルを populate しないので、{ orgSlug, projectSlug, projectId } を手動で書いて作るのが現実的なパスです。一度作られたら手で編集しないでください。
• .arkor/build/index.mjs。arkor build の出力。src/arkor/index.ts を Node 22.6 ターゲットで esbuild した単一バンドルで、bare specifier は外部のままにしてあります。arkor start がこれを実行します。

​

~/.arkor/（ユーザーごと）

• ~/.arkor/credentials.json。認証状態。arkor login --oauth 後の Arkor Cloud OAuth トークンか、未ログインで初使用時に作られる匿名トークンのいずれか。ファイルは mode フィールドが "auth0" か "anon" でタグ付けされており、CLI はどのパスにいるかを把握します。arkor login はこのファイルだけを書きます。.arkor/state.json は 作成しません。
• ~/.arkor/studio-token（一時的）。arkor dev が起動ごとに書く CSRF トークン（モード 0600）。Studio が CLI のローカルサーバーへの呼び出しを認可するのに使います。arkor dev 起動のたびにローテートされます。

​

CLI が探すもの

• arkor dev は Studio の Web サーバーを 127.0.0.1:4000 で起動し、~/.arkor/studio-token を書きます。src/arkor/ をファイル監視はしません。Studio の /api/manifest エンドポイントは確かに runBuild を呼びキャッシュバストクエリで再 import しますが、それは Studio UI が fetch したときだけです（現状は Run training ページのマウント時）。同じページに留まったまま学習を複数回実行すると、ビルド成果物は再利用されます。編集した後は Run training ページをリロード（あるいはターミナルから arkor build）して変更を取り込んでください。arkor dev は単独で .arkor/state.json を書きません。
• arkor build は src/arkor/index.ts（または渡したエントリ）を読んで .arkor/build/index.mjs を書きます。Studio の dev ループの外側で直接呼ぶ必要があるのは CI や、スクリプトから arkor start の直前に走らせる場合などです。
• arkor start はランナー経由でエントリを解決し、.arkor/build/index.mjs がない、もしくは明示的なエントリを渡したときはリビルドして実行します（これが trainer.start() と trainer.wait() を呼びます）。Studio から学習をトリガーすると内部的に arkor start がスポーンされます。