CLI

このページは自動翻訳されており、誤りが含まれる場合があります。誤りを見つけた場合は「このページを編集」リンクからご協力ください。

turian-cli はTurian Studioのヘッドレスコンパニオンです。プロジェクトのスキャフォールディング、メタデータの出力、自己完結型のゲーム実行可能ファイルのコンパイルを——GUI不要で行います。そのため継続的インテグレーションに最適です。


コマンド

new-project

turian-cli new-project <path> "<Display Name>"

assets/ フォルダとスターターシーンを含む新しいプロジェクトディレクトリをスキャフォールディングします。

turian-cli new-project ../my-game "My Game"

info

turian-cli info <path>

プロジェクトのメタデータ(名前、バージョン、アセット数)を出力します。

build

turian-cli build <path>

すべてのアセットを <path>/.cache/game.oap にクックし、build.zig + main.zig を生成し、<path>/.cache/zig-out/bin/game[.exe] にスタンドアロン実行可能ファイルをコンパイルします。

生成されたバイナリは自己完結型です。すべてのアセットを同階層の game.oap から読み取り、エンジンソースツリーを必要としません。

package

turian-cli package <subcommand> [--project <path>] [args]

プロジェクトのパッケージを管理します。--project が指定されない限り、カレントディレクトリで操作します。

サブコマンド 説明
install <source> ローカルパスまたはgit URLからパッケージをインストール
remove <name> マニフェスト名でインストール済みパッケージを削除
update [name] パッケージ(またはすべて)を更新——gitソースは再インストール
list インストール済みパッケージを一覧表示(名前、バージョン、タイプ)
info <name> パッケージの完全なマニフェストを表示
search <query> レジストリを検索(未実装——レジストリ作業で追跡中)

完全なワークフローについてはパッケージガイドを参照してください。


ソースチェックアウトからのビルド

SDKバンドルではなくエンジンリポジトリ内で作業している場合:

zig build cli -- build path/to/my-project

パス解決

turian-cli は以下の優先順位でエンジンソースを検索します:

  1. 環境変数 — 例 TURIAN_ENGINE_ROOT(最高優先順位)。
  2. SDK相対パス — バイナリの隣にある turian-sdk.json マーカーから解決。
  3. ビルド時に埋め込まれたパス — ツリー内開発ビルドのみ存在。

完全なリストは環境変数オーバーライドを参照してください。


debug

turian-cli debug <subcommand> [--host 127.0.0.1] [--port 7777] [--token <secret>]

実行中のゲームのデバッグサーバーに接続し、JSON-RPCクエリを送信します。ゲームに debug モジュールがリンクされ、サーバーが起動している必要があります。

サブコマンド 説明
connect サーバーにPing(ヘルスチェック)
scenes 読み込まれているシーンを一覧表示
inspect <name> 名前でエンティティを検査
entities アクティブシーン内の全エンティティを一覧表示
component <entity> <comp> コンポーネントのフィールドを読み取り
snapshot 完全なシーンスナップショット
schema 組み込みコンポーネントタイプカタログ

完全なメソッド一覧はリモートデバッグプロトコルリファレンスを参照してください。

docs

turian-cli docs export-ai-context [--out <dir>]

実行中のゲームを必要とせず、自己完結型のAIナレッジパックを生成します。すべての出力はコンパイル時のエンジンデータから派生します。

フラグ デフォルト 説明
--out .turian/ 出力ディレクトリ

出力ファイル:

ファイル 内容
engine-overview.md アーキテクチャ、主要概念、クイック接続ガイド
component-schema.json すべての組み込みコンポーネントタイプとフィールド定義
mcp-tools.json 入力スキーマとデバッグメソッドマッピング付きMCPツールカタログ
protocol-reference.json パラメータとエラーコード付きJSON-RPCメソッド一覧
examples/list-scenes.json リクエスト/レスポンスのペア例
examples/inspect-entity.json リクエスト/レスポンスのペア例

CLAUDE.md に追加してClaude Codeにオフラインコンテキストを提供:

@.turian/engine-overview.md

ライブ接続のセットアップについてはMCP統合ガイドを参照してください。

mcp

turian-cli mcp [--host 127.0.0.1] [--port 7777] [--token <secret>]

実行中のゲームのデバッグサーバーによってバックエンドされるMCPサーバー(stdioトランスポート、MCP 2024-11-05)を起動します。Claude CodeまたはCursorがMCPサブプロセスとして起動するように設計されています。

セットアップ手順についてはMCP統合ガイドを参照してください。


CIでの使用

build は完全にヘッドレスであるため、典型的なパイプラインステップは次のとおりです:

build-game:
  script:
    - turian-cli build .
  artifacts:
    paths:
      - .cache/zig-out/bin/

← すべてのドキュメント このページを編集