Executable commands and flags¶
Generated from the executable's Cobra command tree. Use these at the shell, not in the game's slash-command prompt. serve, migrate, admin, bots, and health are operator commands. Their presence does not give a player server access. See Install and Commander for player setup. English help below is the executable contract.
tarmy¶
terminal-army: OGame-style strategy game for the terminal
| Flag | Type | Default | Help |
|---|---|---|---|
--logout |
bool |
false |
delete saved key for this server and exit |
--no-update |
bool |
false |
skip the version check at startup (same as TARMY_NO_UPDATE=1) |
--remote |
string |
https://terminal.army |
terminal-army server URL |
tarmy admin¶
Administrative commands (seed-universe, promote, stats, list-users, bots)
tarmy admin bots¶
Manage the simulated player population (seed, status, list, pause, resume)
tarmy admin bots list¶
List characters in id order
| Flag | Type | Default | Help |
|---|---|---|---|
--all |
bool |
false |
include characters who have quit |
--limit |
int |
40 |
max rows to return |
--offset |
int |
0 |
id-order offset |
tarmy admin bots pause¶
Stop every bot on a running server (the kill switch)
| Flag | Type | Default | Help |
|---|---|---|---|
--note |
string |
`` | why, for whoever reads status next |
tarmy admin bots rescale¶
Pull the population back onto the current growth curve (only ever subtracts)
| Flag | Type | Default | Help |
|---|---|---|---|
--dry-run |
bool |
false |
measure the trim and roll it back |
tarmy admin bots resume¶
Start the population again after a pause
tarmy admin bots seed¶
Create characters spread across the timezone clusters and down a growth curve
| Flag | Type | Default | Help |
|---|---|---|---|
--count |
int |
360 |
how many characters to create |
tarmy admin bots status¶
Show population size, archetype and region mix, and the next logins
| Flag | Type | Default | Help |
|---|---|---|---|
--wakes |
int |
10 |
how many upcoming logins to show |
tarmy admin companion-push¶
Send custom notifications, list phones, inspect deliveries, or retry a failed event
tarmy admin companion-push devices¶
List connected phones and their push state
| Flag | Type | Default | Help |
|---|---|---|---|
--push |
bool |
false |
only phones that accept push |
tarmy admin companion-push retry¶
tarmy admin companion-push send¶
Send a custom notification to commanders, an alliance, or all app users
| Flag | Type | Default | Help |
|---|---|---|---|
--all-app-users |
bool |
false |
every commander with a live companion session |
--alliance |
string |
`` | every member of the alliance with this tag |
--as |
string |
`` | staff account to send as; the operator when empty |
--body |
string |
`` | message text; its opening becomes the notification text |
--dry-run |
bool |
false |
list the recipients and send nothing |
--subject |
string |
`` | notification title and message subject |
--to |
stringSlice |
[] |
commander names, comma separated |
--yes |
bool |
false |
send without a dry run |
tarmy admin companion-push status¶
tarmy admin demote¶
Revoke the admin role and restore the player role
tarmy admin list-users¶
List user accounts in id order
| Flag | Type | Default | Help |
|---|---|---|---|
--limit |
int |
100 |
max rows to return |
--offset |
int |
0 |
id-order offset |
tarmy admin promote¶
Grant the admin role to a user
tarmy admin seed-universe¶
Create the default universe from TARMY_DEFAULT_UNIVERSE_* settings (idempotent)
tarmy admin set-password¶
Set a user's password, prompted on this terminal
tarmy admin stats¶
Print server-wide counters (universes, players, planets, sessions, uptime)
tarmy bots¶
Run the simulated player population worker
tarmy bots run¶
Drive the simulated population and nothing else
tarmy commander¶
set this game up as a commander in your AI assistant
| Flag | Type | Default | Help |
|---|---|---|---|
--allow |
string |
all |
narrow what the commander may do: read, spend, commit, or all |
--for |
string |
`` | which assistant --print should format for: claude, codex, gemini, cursor |
--name |
string |
commander |
what to call it in your assistant |
--no-skill |
bool |
false |
register MCP without installing the bundled game skill |
--print |
bool |
false |
print the configuration instead of installing it |
--remote |
string |
https://terminal.army |
terminal-army server URL |
--remove |
bool |
false |
take the commander back out of your assistant |
--scope |
string |
user |
claude scope: local, user or project |
--skill-only |
bool |
false |
install only the bundled skill, without changing MCP or signing in (defaults to Codex) |
tarmy health¶
Exit 0 if the local server answers /readyz (HTTP up, database reachable)
| Flag | Type | Default | Help |
|---|---|---|---|
--url |
string |
`` | readiness endpoint to ask (default: /readyz on TARMY_HTTP_ADDR) |
tarmy mcp¶
serve this commander to an MCP client over stdio
| Flag | Type | Default | Help |
|---|---|---|---|
--allow |
string |
all |
narrow what the commander may do: read, spend, commit, or all |
--remote |
string |
https://terminal.army |
terminal-army server URL |
tarmy migrate¶
Manage database migrations
tarmy migrate down¶
Roll back the last migration (use --all to roll back every one)
| Flag | Type | Default | Help |
|---|---|---|---|
--all |
bool |
false |
roll back every migration, dropping every table |
tarmy migrate up¶
Apply all pending migrations
tarmy migrate version¶
Show current migration version
tarmy serve¶
Run HTTP API server and queue scheduler
tarmy update¶
Update the tarmy binary
| Flag | Type | Default | Help |
|---|---|---|---|
--force |
bool |
false |
reinstall even when the selected version is already installed |
--from |
string |
https://terminal.army/dl |
base URL to fetch releases from |
--install-dir |
string |
`` | directory to install into (defaults to the current binary directory when writable) |
--to |
string |
latest |
release tag to install, or latest |