> ## Documentation Index
> Fetch the complete documentation index at: https://docs.livlive.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> This is livlive's documentation. An agent reaches livlive from outside through the `livlive` CLI or the livlive MCP server (see /developers/install, /developers/cli and /developers/mcp). The person links it to livlive once, in the browser: `livlive login`, the local MCP's `livlive_login` tool, or the remote MCP at https://backstage.livlive.ai/api/mcp signing in by OAuth; a personal token made in livlive's settings is for CI. Pages marked 準備中 describe parts not decided yet: do not guess their behaviour.

# CLI

> livlive コマンドで、外からの入口の操作を呼び、ステージを PC で作って登録します。

`livlive` コマンドは、外からの入口の操作を呼び、ステージを PC で作って livlive に登録する CLI です。Node.js 22.18 以上で動きます。入れ方は[インストールと連携](https://docs.livlive.ai/developers/install.md)にあります。

## 連携する

| 使い方 | コマンド |
| - | - |
| ブラウザで連携する | `livlive login`(ブラウザで livlive の頁が開きます。開かないときは、ターミナルに出たアドレスを、この PC のブラウザで開きます) |
| アドレスを出すだけにする | `livlive login --no-open` |
| この PC でブラウザを使えない(SSH の先や、サンドボックスの中) | `livlive login --device`(ターミナルにアドレスとコードが出ます。手元の別の PC やスマートフォンなど、どのブラウザでもよいのでアドレスを開き、コードを入れます) |
| 手で作ったトークンを貼る(CI など) | `livlive login --paste`([トークン](https://docs.livlive.ai/developers/authentication.md)) |
| 連携を解く | `livlive logout`(この PC のトークンを livlive で無効にし、この PC からも消します。環境変数の `LIVLIVE_TOKEN` はそのままです) |
| ほかの livlive につなぐ | `--base <アドレス>` を付けます。`https` か、この PC の `http` のアドレスです |

頁で確かめることと、連携でできることは[インストールと連携](https://docs.livlive.ai/developers/install.md)にあります。

### 保存先と環境変数

連携は `~/.config/livlive/config.json` に保存されます。ローカル MCP も、同じ設定を読みます。

| 環境変数 | すること |
| - | - |
| `LIVLIVE_TOKEN` | 保存した連携より先に使うトークンです(CI など)。あると、`livlive login` がそのことを知らせます |
| `LIVLIVE_BASE` | つなぎ先のアドレスです。指定がなければ `https://backstage.livlive.ai` です |
| `LIVLIVE_CONFIG` | 保存先のファイルを変えます |

保存したトークンは、保存したときのつなぎ先にだけ送ります。`LIVLIVE_BASE` でほかのアドレスにつなぐときは、そのアドレスで連携し直してください。

## 操作を呼ぶ

```bash theme={null}
livlive ops                                            # 呼べる操作の一覧
livlive room.read --project <プロジェクトの id>          # 制作部屋を読む
livlive script.check --project <id> --file draft.json   # 構成表の下書きを確かめる
```

操作の名前が、そのままサブコマンドになります。部屋の要る操作には `--project <id>` を付け、入力は `--json '<JSON>'` か `--file <JSON のファイル>` で渡します。答えは JSON で出ます。

いま呼べる操作は `livlive ops` が答えます。それぞれの入力の形は[操作の一覧](https://docs.livlive.ai/developers/reference/ops.md)に、答えの形は[仕組み](https://docs.livlive.ai/developers/how-it-works.md)にあります。

## ステージを作る

| コマンド | すること |
| - | - |
| `livlive stage new <フォルダ>` | ステージのフォルダの空の形を作ります。`--no-game` を付けると、ゲームなし。`--name <名前>` を付けると、連携した PC では、その名前でステージも livlive に作り、フォルダの `livlive.json` に覚えます |
| `livlive stage dev <フォルダ>` | フォルダを livlive の開発用の頁で描いて確かめます。保存するたびに読み直します。`--patrol` で巡回します |
| `livlive stage check <フォルダ>` | 登録のときの検査をすべてかけます。一枚絵・ひとこと・色・世界観のファイルも確かめます。ステージは変えません |
| `livlive stage push <フォルダ>` | ステージに登録します。フォルダに `face/` か `world/` があれば、そのあと一枚絵・ひとこと・色・世界観も付けます。付けるのは、ステージでまだ空いている所だけです |
| `livlive stage list`・`livlive stage read <id>` | あなたのステージの一覧と、登録した空間を読みます |
| `livlive game build`・`livlive game check` | ゲームのルールを PC で組み立て、livlive で確かめます。`check` は、ステージの上で動かしてもみます |
| `livlive picture make`・`livlive model make` | 参考の絵(gpt-image)と模型(Tripo)を、フォルダの `.env` にあるあなたのキーで作ります。livlive は通らず、料金はあなたの OpenAI・Tripo のアカウントにかかります |
| `livlive reference` | livlive のいまのエンジンのリファレンスを出します(livlive が答えないときは、この CLI が持っているもの) |
| `livlive room-kit` | Blender で部屋を作るための、ルームキットのフォルダを出します |

`stage check` と `stage push` は、フォルダの `livlive.json` が名指すステージに送ります。`livlive.json` が無いフォルダには、`--stage <id>` か `--name <名前>` を付けます。ステージの頁で入れた一枚絵・ひとこと・色・世界観を `stage push` で置き換えるのは、`--replace picture,note,tone,world` で名指したものだけです。コマンドごとの使い方は `livlive help` に、進め方は[ステージ開発キット](https://docs.livlive.ai/developers/stage-kit/index.md)にあります。

## 連携の要るコマンド

`livlive ops` と操作、`stage push`・`stage check`・`stage list`・`stage read`、`game build`・`game check` は、連携が要ります。`stage new`・`stage dev`・`picture make`・`model make`・`reference`・`room-kit` は、連携なしで動きます(`stage new --name` がステージも作るのは、連携した PC だけです)。`stage dev` で開く開発用の頁は、livlive にログインしたブラウザで開きます。

## 終わりのコード

| コード | 意味 |
| - | - |
| `0` | できた |
| `1` | 断られた(操作の答えの `ok` が `false`、または livlive がエラーを答えた) |
| `2` | コマンドを使えなかった(引数やフォルダが使えない、連携が無い、livlive に届かない) |

`livlive stage dev --patrol` は、確かめられなかった場所だけが残ったとき `3` で、巡回の報告が `--wait` の秒数(指定がなければ 900 秒)のうちに来なかったとき `2` で終わります。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.