0xDocs 0x.limo

Docs / JavaScript SDK

@0xlimo/cli

The 0x command-line tool as an npm package; the full command reference is in the 0x CLI section.

@0xlimo/cli (registry version 0.1.4) is the 0x command. It scaffolds a game from a starter, runs it locally with a swarm and a broadcast service of its own, publishes it to 0x hosting, submits the store listing and deploys a hosted game server.

bash
curl -fsSL https://0x.limo/sdk/install.sh | sh      # installs into ~/.0x, no sudo

The installer runs npm install @0xlimo/cli from https://0x.limo/npm/ into ~/.0x (ZEROX_HOME). It accepts ZEROX_REGISTRY, ZEROX_VERSION, ZEROX_NO_MODIFY_PATH=1 and ZEROX_NO_NPMRC=1, and needs Node.js 20 or later.

The CLI's own dependencies, which hosted sites get as well, are @0xlimo/swarm-sw, @0xlimo/net, @0xlimo/iap, @0xlimo/byo-assets and @x1/meshtorrent.

Every command, every flag and 0x.config.json are documented in the 0x CLI section.