Skip to content

Command Reference

All Portlight commands work identically through the npm wrapper. Prefix with npx @mcptoolshop/portlight (or just portlight if installed globally).

Game commands

GroupCommandsDescription
Setupnew, captain-select, load, saveCreate captains (9 types), manage saves
Tradingmarket, buy, sell, cargoInspect prices, trade goods
Navigationroutes, sail, advance, port, mapPlan and execute voyages, view the world map
Shipprovision, repair, hire, shipyard, fleetMaintain, upgrade, and manage vessels
Contractscontracts, accept, obligations, abandonCommercial agreements
Financecredit, repay, insureCredit, debt, and insurance
Infrastructureinfra, warehouse, broker, licenseBuild your trade house
Careercaptain, reputation, milestones, status, ledgerTrack progress and standing
WorldmapASCII world map with ports, routes, and regions
InterfacetuiInteractive terminal dashboard (Textual)
HelpguideIn-game command reference

Wrapper-specific behavior

The npm wrapper is transparent — it passes all arguments directly to the Portlight binary. There are no wrapper-specific flags or commands.

Binary location

The cached binary lives at:

  • Linux/macOS: ~/.cache/mcptoolshop/portlight/
  • Windows: %LOCALAPPDATA%/mcptoolshop/portlight/

Updating

When a new Portlight release is published, update the npm package:

Terminal window
npm install -g @mcptoolshop/portlight@latest

The new version will download the updated binary on first run.

Clearing the cache

If you need to force a fresh download (e.g., after a corrupted download), delete the cache directory for your platform:

Terminal window
# Linux/macOS
rm -rf ~/.cache/mcptoolshop/portlight/
# Windows (PowerShell)
Remove-Item -Recurse "$env:LOCALAPPDATA\mcptoolshop\portlight\"

The next run will re-download and re-verify the binary automatically.

Troubleshooting

ProblemSolution
Unsupported platform errorYour OS/architecture is not supported. See the platform table above. On Apple Silicon, try arch -x86_64 npx @mcptoolshop/portlight ...
Download failsCheck your internet connection. The wrapper downloads from github.com — ensure it is not blocked by a firewall or proxy.
Checksum mismatchThe download may have been corrupted. Delete the cache directory (see above) and try again.
EACCES permission errorYou may need to fix npm permissions. See the npm docs on permissions.

Security

  • Downloads from github.com over HTTPS only
  • SHA256 checksum verification on every download
  • No telemetry, no tracking, no phone-home
  • Binary runs with your user permissions — no elevated access needed