Skip to content
Status

Status

Make, test, and build Vishnu cartridge games

Vishnu declares source version 0.1.0. Until 1.0, a minor release can change the public API, so pin the version you test against.

Package qualification does not publish a release. Check the npm registry before choosing a released version.

  • Node 24 or newer.
  • Installing the package and its dependencies needs a package registry or a populated package-manager cache. Ordinary local authoring needs no account or network after installation.
  • A missing or corrupted file in the bundled kernel stops the command. Replace the damaged package; Vishnu never silently changes the pinned kernel.
  • A kernel file with the wrong size or digest is rejected. Vishnu does not fall back to another kernel.
  • vishnu test fails when the project has no *.test.ts files, so an empty project never reports a green run.
  • vishnu new refuses a name that is not kebab-case or a directory that already exists.
  • defineCartridge and the authoring factories throw CartridgeError, which carries every diagnostic it found. The CLI prints project, kernel and cartridge errors as a plain message without a stack.
  • The CLI has no login, upload or publish command. vishnu build stops at a static site.

MIT. See LICENSE. The CLI bundles Clack and its small dependency closure. Their license notices ship in dist/cli/THIRD_PARTY_LICENSES.txt.