s&box CLI は何をしますか?
s&boxゲームエンジン(Facepunch Studios、Source 2)向けのエージェントネイティブCLI。14のグループに79以上のコマンドを提供します。.scene、.prefab、.vmat、.sound、Input.config、Collision.configのJSONファイルを直接操作し、慣用的なC#コンポーネントを生成し、プロジェクト全体でリアルタイムのアセットグラフを実行します。
インストール
pip install git+https://github.com/HKUDS/CLI-Anything.git#subdirectory=sbox/agent-harness
要件
- Python 3.10+
- Steam経由でインストールされたs&box - 自動検出されます。または、
SBOX_PATHでカスタムインストールディレクトリを設定します。 - ほとんどのコマンドはプロジェクトのJSONファイル上で完全に動作します - s&boxが実行されている必要はありません。
グローバルオプション
--json 機械可読なJSON出力(エージェント使用時は常に指定)
--project PATH プロジェクトディレクトリ(省略時はカレントディレクトリの.sbprojから自動検出)
コマンドグループ
project - s&boxプロジェクトの管理
cli-anything-sbox project new --name MyGame --output-dir ./MyGame
cli-anything-sbox --json project info
cli-anything-sbox project config --max-players 32 --tick-rate 64
cli-anything-sbox --json --project ./MyGame project add-package facepunch.libsdf
cli-anything-sbox --json --project ./MyGame project remove-package facepunch.libsdf
# リンター:壊れたアセット参照、重複GUID、不正なInput.config
cli-anything-sbox --json --project ./MyGame project validate
cli-anything-sbox --project ./MyGame project validate --no-inputs --no-guids
scene - .sceneファイルの操作
cli-anything-sbox scene new --name gameplay -o ./Assets/scenes/gameplay.scene
cli-anything-sbox --json scene info ./scene.scene
cli-anything-sbox --json scene list ./scene.scene
cli-anything-sbox scene add-object ./scene.scene Enemy --position "100,0,0" --components "model,box_collider,rigidbody" --tags "enemy"
cli-anything-sbox scene remove-object ./scene.scene --name Enemy
cli-anything-sbox scene add-component ./scene.scene <object-guid> Sandbox.PointLight
cli-anything-sbox scene remove-component ./scene.scene <object-guid> --component-type Sandbox.Rigidbody
cli-anything-sbox --json scene modify-object ./scene.scene --guid <guid> --name NewName --position "200,0,0"
cli-anything-sbox --json scene clone-object ./scene.scene --name Enemy --new-name EnemyCopy --position "300,0,0"
cli-anything-sbox --json scene get-object ./scene.scene --name Sun
cli-anything-sbox scene set-property ./scene.scene --fixed-update-freq 64 --timescale 0.5
cli-anything-sbox scene set-navmesh ./scene.scene --enabled --agent-height 72 --agent-radius 16
cli-anything-sbox --json scene list-presets
cli-anything-sbox --json scene modify-component ./scene.scene <object-guid> <component-guid> --properties '{"Damage":50}'
# 1つ以上のフィルターに一致するオブジェクトを検索(AND結合)
cli-anything-sbox --json scene query ./scene.scene --has-component rigidbody --has-tag tower
cli-anything-sbox --json scene query ./scene.scene --name-regex "^Tower\d$" --in-bounds "0,-500,-50,1000,500,50"
# シーンからすべてのアセット参照(.vmdl、.vmat、.vsnd、.vtex、.vpcf、.prefab)を抽出
cli-anything-sbox --json scene refs ./scene.scene
# クエリに一致するすべてのオブジェクトに同じ変更を適用
cli-anything-sbox --json scene bulk-modify ./scene.scene --has-tag tower --position "0,0,100" --enable
# 2つのシーン間の構造的差分(追加/削除/変更されたGameObject + SceneProperties)
cli-anything-sbox --json scene diff ./old.scene ./new.scene
# プレハブをシーン内のGameObjectとして挿入
cli-anything-sbox --json scene instantiate-prefab ./level.scene ./Assets/prefabs/bullet.prefab --position "10,0,0"
prefab - .prefabファイルの管理
cli-anything-sbox prefab new --name Bullet -o ./Assets/prefabs/bullet.prefab --components "model,sphere_collider,rigidbody"
cli-anything-sbox --json prefab info ./Assets/prefabs/bullet.prefab
cli-anything-sbox prefab from-scene ./scene.scene <object-guid> -o ./Assets/prefabs/extracted.prefab
cli-anything-sbox --json prefab add-component ./prefab.prefab rigidbody
cli-anything-sbox prefab remove-component ./prefab.prefab --component-type Sandbox.Rigidbody
cli-anything-sbox --json prefab list
# プレハブ内のアセット参照
cli-anything-sbox --json prefab refs ./prefab.prefab
# プレハブ上のコンポーネントプロパティを変更(コンポーネントタイプまたはコンポーネントGUIDで指定)
cli-anything-sbox --json prefab modify-component ./prefab.prefab --component-type Sandbox.Rigidbody --properties '{"Gravity":false,"MassOverride":50}'
# 2つのプレハブ間の構造的差分(ルート + 名前付き子)
cli-anything-sbox --json prefab diff ./old.prefab ./new.prefab
codegen - C#コードの生成
# プレーンなComponent
cli-anything-sbox codegen component --name PlayerController --methods OnUpdate,OnFixedUpdate -o ./Code/PlayerController.cs
# [Property] フィールドを持つComponent
cli-anything-sbox --json codegen component --name Tower --properties '[{"name":"Damage","type":"float","default":"25f"},{"name":"Range","type":"float","default":"500f"}]'
# ネットワーク対応コンポーネント(部分クラス)とRPCメソッドスタブ
cli-anything-sbox codegen component --name NetPlayer --networked --methods OnUpdate,OnFixedUpdate --rpc-methods "Fire:Broadcast,TakeDamage:Host" -o ./Code/NetPlayer.cs
# GameResource
cli-anything-sbox codegen gameresource --name TowerData --display-name "Tower Data" --extension tower -o ./Code/TowerData.cs
# エディタメニュー(Editor/アセンブリ)
cli-anything-sbox codegen editor-menu --name MyTools --menu-path "Editor/My Tools/Open" -o ./Editor/MyTools.cs
# プレーンなRazor UIコンポーネント(.razor + .razor.scss)
cli-anything-sbox codegen razor --name HudPanel --properties '[{"name":"Score","type":"int","default":"0"}]' -o ./UI/HudPanel.razor
# 静的クラスまたは基本クラス派生
cli-anything-sbox codegen class --name Math2 --static -o ./Code/Math2.cs
# PanelComponent + 兄弟ScreenPanelのスキャフォールド(s&boxの癖を処理:PanelComponentの入力は、両方が同じGameObject上にある場合にのみ機能)。
# .razor + .razor.scss + ペースト可能なGameObjectスニペットを出力するか、--scene で直接シーンに追加します。
cli-anything-sbox --json codegen panel-component --name HudBar -o ./UI/HudBar.razor
cli-anything-sbox codegen panel-component --name Crosshair -o ./UI/Crosshair.razor --scene ./Assets/scenes/game.scene
input - Input.configの管理
cli-anything-sbox --json input list
cli-anything-sbox input add --name PlaceTower --group Gameplay --keyboard mouse1 --gamepad RightTrigger
cli-anything-sbox input remove --name PlaceTower
cli-anything-sbox input set --name Attack1 --keyboard mouse1
collision - Collision.configの管理
cli-anything-sbox --json collision list
cli-anything-sbox collision add-layer --name projectile --default Collide
cli-anything-sbox collision add-rule --layer-a projectile --layer-b solid --result Collide
cli-anything-sbox collision remove-rule --layer-a projectile --layer-b solid
cli-anything-sbox collision remove-layer --name projectile
material - .vmatマテリアルの管理
cli-anything-sbox --json material new --name floor --shader complex --color-texture "textures/floor.tga" --metalness 0.3 -o ./Assets/materials/floor.vmat
cli-anything-sbox --json material info ./Assets/materials/floor.vmat
cli-anything-sbox --json material list
cli-anything-sbox --json material set ./Assets/materials/floor.vmat --metalness 0.8
sound - .soundイベントの管理
cli-anything-sbox --json sound new --name gunshot --sounds "sounds/gun1.vsnd,sounds/gun2.vsnd" --volume 0.8 -o ./Assets/sounds/gunshot.sound
cli-anything-sbox --json sound info ./Assets/sounds/gunshot.sound
cli-anything-sbox --json sound list
cli-anything-sbox --json sound set ./Assets/sounds/gunshot.sound --volume 0.5
localization - 翻訳の管理
cli-anything-sbox localization new --lang en -o ./Localization/en.json
cli-anything-sbox localization set ./Localization/en.json --key "game.title" --value "My Game"
cli-anything-sbox --json localization list ./Localization/en.json
cli-anything-sbox localization get ./Localization/en.json --key "game.title"
cli-anything-sbox localization remove ./Localization/en.json --key "game.title"
cli-anything-sbox localization bulk-set ./Localization/en.json --keys '{"ui.start":"Start","ui.quit":"Quit"}'
server - 専用サーバー
cli-anything-sbox server info
cli-anything-sbox server start --game my_game --map facepunch.flatgrass
asset - アセット管理と逆引き参照
cli-anything-sbox --json asset list --type scene
cli-anything-sbox --json asset info ./Assets/scenes/minimal.scene
cli-anything-sbox asset compile ./Assets/materials/floor.vmat
# このアセットを参照しているシーン/プレハブは?
cli-anything-sbox --json --project ./MyGame asset find-refs models/myteam/widget.vmdl
# 未参照のアセットを検索(タイプごと、または全参照可能タイプ)
cli-anything-sbox --json --project ./MyGame asset find-unused
cli-anything-sbox --json --project ./MyGame asset find-unused --type model --type material
# アセットの名前を変更し、すべてのシーン/プレハブ参照を更新(拡張子を省略すると保持)
cli-anything-sbox --json --project ./MyGame asset rename models/team/widget.vmdl gizmo
cli-anything-sbox --project ./MyGame asset rename models/team/widget.vmdl gizmo --dry-run
# アセットをディレクトリ間で移動し、すべての参照を更新
cli-anything-sbox --json --project ./MyGame asset move models/team/widget.vmdl models/shared/widget.vmdl
session - 状態管理
cli-anything-sbox session status
cli-anything-sbox session undo
cli-anything-sbox session redo
test - 自動マップ/シーン生成ハーネス
cli-anything-sbox test setup
cli-anything-sbox --json test run
launch - s&boxエディタでプロジェクトを開く
cli-anything-sbox launch
コンポーネントプリセット
scene add-object、prefab newなどで--componentsと共に使用可能な29の短い名前。それぞれがSandbox.*コンポーネントタイプにマッピングされます。
| プリセット | コンポーネントタイプ |
|---|---|
model | Sandbox.ModelRenderer |
box_collider | Sandbox.BoxCollider |
sphere_collider | Sandbox.SphereCollider |
capsule_collider | Sandbox.CapsuleCollider |
plane_collider | Sandbox.PlaneCollider |
model_collider | Sandbox.ModelCollider |
rigidbody | Sandbox.Rigidbody |
character_controller | Sandbox.CharacterController |
player_controller | Sandbox.PlayerController |
camera | Sandbox.CameraComponent |
light_directional | Sandbox.DirectionalLight |
light_point | Sandbox.PointLight |
spot_light | Sandbox.SpotLight |
ambient_light | Sandbox.AmbientLight |
sprite_renderer | Sandbox.SpriteRenderer |
skinned_model_renderer | Sandbox.SkinnedModelRenderer |
text_renderer | Sandbox.TextRenderer |
line_renderer | Sandbox.LineRenderer |
decal_renderer | Sandbox.DecalRenderer |
trail_renderer | Sandbox.TrailRenderer |
particle_effect | Sandbox.ParticleEffect |
sound_point | Sandbox.SoundPointComponent |
nav_mesh_agent | Sandbox.NavMeshAgent |
screen_panel | Sandbox.ScreenPanel |
world_panel | Sandbox.WorldPanel |
fixed_joint | Sandbox.FixedJoint |
hinge_joint | Sandbox.HingeJoint |
spring_joint | Sandbox.SpringJoint |
ball_socket_joint | Sandbox.BallSocketJoint |
scene list-presetsは、ライブプリセットレジストリをJSONとして返します。
エージェント使用パターン
エージェント駆動の呼び出しでは、必ず--jsonを渡してください。jqを介してパイプし、GUIDとパスをコマンド間で連鎖させます:
# プロジェクトをブートストラップ
sbproj=$(cli-anything-sbox --json project new --name MyGame --output-dir /tmp/MyGame | jq -r '.sbproj')
cd /tmp/MyGame
# 特定のコンポーネントレイアウトでタワーを追加し、そのGUIDをキャプチャ
guid=$(cli-anything-sbox --json scene add-object ./Assets/scenes/main.scene Tower \
--components "model,box_collider,rigidbody" --tags "tower" \
| jq -r '.guid')
# 対応するC#コンポーネントを生成(ネットワーク対応)
cli-anything-sbox --json codegen component --name Tower --networked \
--rpc-methods "Fire:Host" --properties '[{"name":"Damage","type":"float","default":"25f"}]' \
-o ./Code/Tower.cs
# シーン内のすべてのタワーを一括調整
cli-anything-sbox --json scene bulk-modify ./Assets/scenes/main.scene \
--has-tag tower --enable --position-y-add 50
# コミット前に検証
cli-anything-sbox --json project validate
REPLモード
cli-anything-sboxを引数なしで実行すると、スタイル付きプロンプトの対話型REPLが起動します:
$ cli-anything-sbox
cli-anything-sbox> project info
cli-anything-sbox> scene list ./Assets/scenes/main.scene
cli-anything-sbox> codegen component --name Foo -o ./Code/Foo.cs
cli-anything-sbox> quit
環境変数
| 変数 | 説明 | デフォルト |
|---|---|---|
SBOX_PATH | s&boxインストールディレクトリ | Steamライブラリフォルダから自動検出 |
CLI_ANYTHING_SKILL_REPO | repl_skinがSKILL.mdを読み取るリポジトリを上書き | HKUDS/CLI-Anything |