CLI reference

Start with Install the CLI. The CLI needs Node.js 20 or newer. Run project commands from your Rojo or Argon project folder.

The CLI comes with the Pro plan and up, and with beta access on any plan. On Individual, signing the CLI in is turned down with an upgrade message; the Studio plugin, and the hosted MCP for Claude Code, Codex and Cursor, keep working.

Authentication

Sign in on the website and create a personal token in Settings → Studio → AI tools. Set it in the terminal where you run the CLI. There is no CLI login command.

export SHIPLUA_TOKEN=shiplua_your_token

$env:SHIPLUA_TOKEN = "shiplua_your_token"

Replace the example with your own token and keep it private. Chat, AI settings and saving funnels need a token. The local bridge and local Studio tools over MCP do not; MCP tools that read or save studio data do.

shiplua chat [question]

Start an interactive terminal agent, or pass a question. It uses your selected AI mode and checks your plan’s access first. In interactive chat, type /exit or /quit to leave. Studio tools require the plugin connection; chat prints a connection code when it starts its local agent.

shiplua chat "Is my shipLua SDK up to date?"

shiplua ai

Show your AI mode, plan, remaining credits and whether chat is available.

shiplua ai use own | shiplua ai use credits

Change the AI mode shared with your dashboard. Own mode uses ANTHROPIC_API_KEY, or hands off to the AI CLI named by SHIPLUA_AI_CLI. Credits mode uses your shipLua credits.

shiplua ai use own
shiplua ai

shiplua mcp

Start the MCP server over standard input and output for Claude Code, Codex or Cursor. shiplua-mcp is the equivalent installed command. It also starts the local Studio bridge and prints the connection code to standard error. See AI tool setup for editor configuration.

shiplua bridge

Start the bridge on 127.0.0.1:47615 and show a connection code. In Studio, open shipLua → Agent → Connect AI tools and enter it. Leave this process running. Use either shiplua bridge or shiplua mcp; they use the same port. If the port is busy, close the other process or set the same alternate port in the CLI and plugin.

shiplua setup funnel

In a Rojo or Argon folder containing default.project.json, plan funnel tracking, choose steps and preview file changes before approving them. It can add or update the SDK, backs up changed files, and saves the funnel to your dashboard. Set SHIPLUA_PROJECT_ID when your studio has more than one game. shiplua setup funnels is an alias.

shiplua update

Check and update the SDK in the current folder and this CLI, then report the Studio plugin version last seen by the bridge. A plugin update uses its install link and a Studio restart. The command does not update the installed Studio plugin itself.

Help and version

• shiplua, shiplua help, shiplua --help or shiplua -h: show command help.
• shiplua --version, shiplua -v or shiplua version: print the installed CLI version.

Environment settings

SHIPLUA_TOKEN

Personal token for authenticated studio requests.

SHIPLUA_PROJECT_ID

Experience UUID. Funnel setup selects the only game automatically when this is unset.

SHIPLUA_URL

Site origin. Default: https://shiplua.com.

SHIPLUA_BRIDGE_PORT

Local bridge port, 1025–65535. Default: 47615.

SHIPLUA_HOME

Bridge key, update state and backups directory. Default: ~/.shiplua.

ANTHROPIC_API_KEY

Your key for own AI mode, sent only to Anthropic.

SHIPLUA_AI_CLI

Existing AI CLI to use in own mode, for example claude.

SHIPLUA_MODEL

Own-key model. Default: claude-opus-5-5.