alpha

shiploadcli

1.0.0-next.22 2026-05-23

shiploadcli is a command-line tool for playing Shipload while the full game client is in development. It runs on testnet and is meant for technical testers helping us shake out bugs and shape the design. If you’d rather wait for the graphical client, that’s fine — this isn’t the intended way to play, just the earliest.

39 commands testnet
shipload · alpha 
shiploadcli whoamiactor       player.xpermission  activepubkey      PUB_K1_5Cy...uP8shiploadcli entitiesEntities for player.x (2):  TYPE        ID   NAME        STATUS   TASKS  ship         1   Starter     idle     —  container    2   —           idle     —shiploadcli ship 1 travel -4 2 --waitscheduled — energy 842 → 530traveling...

1. Install

Fastest path: download shiploadcli from the latest release. Pick your platform below; the commands download, unpack, and run it.

shipload · install 
curl -LO https://github.com/shipload/toolkit/releases/download/cli-v1.0.0-next.22/shiploadcli-mac-arm64.zipunzip shiploadcli-mac-arm64.zipmv shiploadcli-mac-arm64 shiploadcli./shiploadcli --version

If the last command prints a version (e.g. shiploadcli 0.1.2), you’re done. Move the binary onto your $PATH if you want to run it from anywhere.

Build from source for contributors

Clone shipload/toolkit, install with Bun, then compile a shiploadcli binary for the platform you picked above.

shipload · from source 
git clone https://github.com/shipload/toolkit.gitcd toolkitbun installcd packages/clibun build src/index.ts --compile --target=bun-darwin-arm64 --outfile shiploadcli./shiploadcli --version

2. Configure

Run ./shiploadcli init --cwd to create a config.ini next to the binary:

config.ini 
[default]# Private key that signs transactions. Treat this file as a secret.private_key = PVT_K1_REPLACE_ME# Antelope account this CLI acts as.actor = myaccount# Permission to sign with. Defaults to "active" if omitted.permission = active

Open config.ini and replace PVT_K1_REPLACE_ME and myaccount with your Antelope testnet key and account name. The file is written with mode 0600 (read/write only for you).

Never pass your key on the command line or in an environment variable — both leak to shell history and process listings.

Other config locations multi-account, per-project

Running shiploadcli init without --cwd writes to your user config dir: ~/.config/shipload/config.ini on macOS/Linux, %APPDATA%\shipload\config.ini on Windows. You can also point at any path with the $PLAYER_CONFIG env var. Lookup order: $PLAYER_CONFIG → ./config.ini → user config dir.

3. First run

Three commands get you in the game:

  • foundcompany registers the name of the fictional company you own in-game. Your Antelope account stays the authoritative owner; the company name is what shows up on the map and leaderboards.
  • join registers you as a player.
  • claimstarter gives you a free starter ship at (0, 0).
shipload · bootstrap 
./shiploadcli foundcompany "Event Horizon Logistics"./shiploadcli join./shiploadcli claimstarter        # testnet / debug builds only

Each command prints a description and a link to the transaction on jungle4.unicove.com — that’s your success signal.

4. Look around

Read-only commands for checking state — what you own, where it is, what’s reachable. Run them any time you want to see what’s going on.

shipload · look 
./shiploadcli entities              # list ships, warehouses, containers (with IDs)./shiploadcli ship <id>             # full state of one entity./shiploadcli ship <id> nearby      # systems your ship can travel to

Replace <id> with a number from entities. Every action in the loop below needs an entity ID, and entities is how you find yours. Add --json for raw output (handy for scripts).

5. Take action

Actions take real-world time to complete — a travel might take minutes, a craft longer. shiploadcli puts the same flags on every action so you can preview the cost, fire and walk away, or block until done.

shipload · action 
shiploadcli ship <id> travel -4 2 --estimate                # 1. previewshiploadcli ship <id> travel -4 2                           # 2. commit (returns immediately)shiploadcli ship <id> travel -4 2 --wait --auto-resolve     #    or, with --wait, block until done

Same shape for any action — swap ship <id> travel -4 2 for the command and arguments you actually want. Replace <id> with your real ship ID from entities.

--wait Block until the scheduled task completes, then resolve and print post-state.
--estimate Preview duration, energy, and cargo delta. No submit.
--auto-resolve Resolve completed tasks on the target before acting.

Commands

39 commands. Filter below, or run shiploadcli <command> --help for signatures and flags.

39/39

Query

read-only

All commands accept --json for raw JSON output.

whoami Who the CLI is signed in as.
status Whether the game is on, and the contracts the CLI is talking to.
player [account] Player record. Defaults to self.
entity <type> <id> Full state for a ship, warehouse, or container.
entities [owner] List entities for an owner.
<type> <id> inventory What an entity is carrying.
<type> <id> tasks Scheduled + pending tasks.
<type> <id> nearby Systems reachable from an entity.
stratum <x> <y> [i] Strata at a location. Add index to see one.
location <x> <y> Metadata for a coordinate.
epoch Current epoch seed and timing.
recipe [id] List recipes or show one.
resources Resource definitions.
items Item definitions.
modules Module definitions.
nftinfo NFT schemas and which items map to each.
config Server game config.

Action

transacting

All commands accept --estimate, --wait, and --auto-resolve.

Bootstrap

foundcompany <name> Create a company on the platform.
join Join the Shipload game.
claimstarter [x] [y] Claim a T1 starter ship. Testnet only.

Movement

<type> <id> travel <x> <y> Fly a ship to a coordinate.
grouptravel <entities> <x> <y> Travel multiple entities together.
<type> <id> warp <x> <y> Instant transit via warp module.

Cargo

<src> gather <dest> <i> <qty> Extract resources from a stratum.
<src> transfer <dest> <item> <stack-id> <qty> Move cargo between entities.

Fleet

<type> <id> recharge Recharge energy with a generator.
<type> <id> craft <recipe> <qty> Produce items from a recipe.
<type> <id> blend Merge stacks into a blended one.
<type> <id> deploy <packed> <name> Deploy an entity from a packed cargo item.
<type> <id> wrap <owner> <cargo> <qty> Wrap cargo into an NFT.
<type> <id> addmodule <slot> <cargo> Attach a module to a slot.
<type> <id> rmmodule <slot> Remove a module from a slot.

Tasks

<type> <id> resolve Process completed tasks.
<type> <id> cancel <count> Cancel pending tasks.
<type> <id> wait Block until the active task ends.

Tools

diagnostics
tools scan <radius> Scan strata in a radius. God-roll leaderboard.
tools find <resource-id> Locate the nearest stratum for a resource.
tools verify-tiers Verify world-gen reserve tiers.

Utility

binary management
update Update to the latest release. Add --check to see the version without installing.