CLI

Esta página foi traduzida automaticamente e pode conter erros. Encontrou um problema? Use o link "Edit this page" para ajudar a corrigir.

turian-cli é a ferramenta headless que acompanha o Turian Studio. Ele cria a estrutura de projetos, exibe metadados e compila executáveis de jogos autocontidos — sem necessidade de GUI, o que o torna ideal para integração contínua.

Comandos

new-project

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

Cria a estrutura de um novo diretório de projeto com uma pasta assets/ e uma cena inicial.

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

info

turian-cli info <path>

Exibe os metadados do projeto (nome, versão, contagem de assets).

build

turian-cli build <path>

Processa (cook) cada asset em <path>/.cache/game.oap, gera build.zig + main.zig e compila um executável autônomo em <path>/.cache/zig-out/bin/game[.exe].

O binário resultante é autocontido: ele lê todos os assets do arquivo game.oap irmão e não precisa da árvore de código-fonte do engine para ser executado.

package

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

Gerencie os pacotes de um projeto. Opera no diretório atual, a menos que --project seja fornecido.

Subcomando Descrição
install <source> Instala um pacote a partir de um caminho local ou URL git
remove <name> Remove um pacote instalado pelo nome do seu manifesto
update [name] Atualiza um pacote (ou todos) — reinstala para fontes git
list Lista os pacotes instalados (nome, versão, tipo)
info <name> Exibe o manifesto completo de um pacote
search <query> Pesquisa no registro (ainda não disponível — monitorado no trabalho do registro)

Consulte o guia de Pacotes para ver o fluxo de trabalho completo.

Compilando a partir de um checkout de código-fonte

Se você estiver trabalhando dentro do repositório do engine em vez de um pacote do SDK:

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

Resolução de caminhos

O turian-cli encontra os códigos-fontes do engine nesta ordem de prioridade:

  1. Variáveis de ambiente — ex: TURIAN_ENGINE_ROOT (prioridade mais alta).
  2. Caminhos relativos ao SDK — resolvidos a partir do marcador turian-sdk.json ao lado do binário.
  3. Caminhos embutidos em tempo de compilação — presentes apenas em builds de desenvolvimento locais (in-tree).

Consulte as Sobreposições de variáveis de ambiente para obter a lista completa.

debug

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

Conecta-se ao servidor de depuração de um jogo em execução e envia consultas JSON-RPC. Requer que o jogo tenha o módulo debug vinculado e o servidor iniciado.

Subcomando Descrição
connect Envia um ping para o servidor (teste de funcionamento)
scenes Lista as cenas carregadas
inspect <name> Inspeciona uma entidade pelo nome
entities Lista todas as entidades na cena ativa
component <entity> <comp> Lê os campos de um componente
snapshot Snapshot completo da cena
schema Catálogo de tipos de componentes nativos

Consulte a referência do Protocolo de Depuração Remota para a lista completa de métodos.

docs

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

Gera um pacote de conhecimento de IA autocontido sem a necessidade de um jogo em execução. Todas as saídas são derivadas dos dados do engine em tempo de compilação.

Flag Padrão Descrição
--out .turian/ Diretório de saída

Arquivos de saída:

Arquivo Conteúdo
engine-overview.md Arquitetura, conceitos-chave, guia rápido de conexão
component-schema.json Todos os tipos de componentes nativos com definições de campos
mcp-tools.json Catálogo de ferramentas MCP com esquemas de input e mapeamentos de métodos de depuração
protocol-reference.json Lista de métodos JSON-RPC com parâmetros e códigos de erro
examples/list-scenes.json Par de exemplo de requisição/resposta
examples/inspect-entity.json Par de exemplo de requisição/resposta

Adicione ao CLAUDE.md para dar contexto offline ao Claude Code:

@.turian/engine-overview.md

Consulte o guia de Integração MCP para a configuração da conexão ativa.

mcp

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

Inicia um servidor MCP (transporte stdio, MCP 2024-11-05) sustentado pelo servidor de depuração do jogo em execução. Projetado para ser iniciado pelo Claude Code ou Cursor como um subprocesso MCP.

Consulte o guia de Integração MCP para instruções de configuração.

Uso em CI

Como o build é totalmente headless, uma etapa típica do pipeline é apenas:

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

← Toda a documentação Editar esta página