indiekku

Documentation

v0.5.0

CLI Commands

Complete reference for all indiekku command-line interface commands.

serve

Start the indiekku API server in the background.

indiekku serve

This command starts a long-running API server that manages Docker containers and maintains state. The server runs on localhost:3000 by default.

First Run

On first run, indiekku will generate an API key and display it in the terminal. This key is required for authentication and is saved to .indiekku_apikey.

start

Start a new game server instance.

indiekku start [--port PORT]

Options

  • --port - Specify a custom port (default: auto-assigned starting from 7777)

Examples

Start server on auto-assigned port

indiekku start

Start server on specific port

indiekku start --port 7779

stop

Stop a running game server instance.

indiekku stop SERVER_NAME

Server Names

Servers are assigned video game themed random names for easy identification. Use indiekku ps to see the names of your running servers.

Arguments

  • SERVER_NAME - Name of the server to stop (e.g., legendary-sword, crimson-dragon)

Example

indiekku stop legendary-sword

ps

List all running game server instances.

indiekku ps

Displays information about each running server including name (e.g., "legendary-sword"), port, player count, and uptime.

logs

View logs from running servers.

indiekku logs

Shows combined logs from all running game server containers. Useful for debugging server issues.

shutdown

Shutdown the indiekku API server.

indiekku shutdown

Gracefully stops the background API server and all running game server containers.

Common Workflows

Starting Your First Server

# Start the API server
indiekku serve

# Start a game server
indiekku start

# Check running servers
indiekku ps

Managing Multiple Servers

# Start multiple servers on different ports
indiekku start --port 7777
indiekku start --port 7778
indiekku start --port 7779

# List all running servers (shows names like legendary-sword, crimson-dragon)
indiekku ps

# Stop a specific server by name
indiekku stop crimson-dragon

Debugging Server Issues

# View server logs
indiekku logs

# Check server status
indiekku ps
Need help? Check out the Quick Start guide or open an issue on GitHub.