create-zx-vibes
v0.2.2
Published
Create zx-vibes ZX Spectrum agent projects.
Downloads
769
Readme
create-zx-vibes
Project generator for zx-vibes ZX Spectrum 48K agent projects.
Current package version in this repository: 0.2.2.
Usage
pnpm create zx-vibes my-game --template game
cd my-game
npm run doctor
npm run build
npm run verify
npm run previewAvailable templates:
gameplatformer
Dependencies install by default. Use --no-install for offline work or when
testing an unpublished local checkout:
pnpm create zx-vibes my-platformer --template platformer --no-installThe CLI also accepts --install explicitly, but it is already the default.
For a complete install-to-verified-project manual, including Codex, Claude
Code, optional MCP setup, and the manual CLI loop, see
docs/manual/. The published manual lives under the
zx-vibes Pages site at https://alvaromah.github.io/zx-vibes/manual/.
Generated Project Contract
Generated projects include:
src/main.asmas the assembler entry point.lib/helpers for screen and keyboard routines.tests/smoke.test.jsondeclarative verification.zx.config.jsonbuild configuration.- npm scripts for
doctor,build,run,screen,test,verify,preview, and advancedzxspassthrough commands. AGENTS.mdandCLAUDE.mdgenerated from the shared agent playbook..mcp.jsonfor Claude-compatible MCP clients.docs/agents/codex-mcp.tomlfor Codex MCP configuration.- local
docs/reference/anddocs/agents/skills/copies.
Starter package metadata currently uses a zx-vibes dev dependency floor of
^0.2.1, which resolves to the latest compatible release during normal
installs.
Relationship To zxs new
create-zx-vibes and zxs new intentionally create the same project contract:
default install, --no-install, MCP config files, local reference docs, local
agent skills, and the same starter templates.
Development
From the repository root:
pnpm --filter create-zx-vibes build
pnpm --filter create-zx-vibes typecheck
pnpm --filter create-zx-vibes lint
pnpm --filter create-zx-vibes test
pnpm --filter create-zx-vibes run check:assetscheck:assets verifies that the package copy of root starters/ and docs/
has not drifted.
License
MIT. Generated projects depend on zx-vibes, whose emulator dependency includes
a ZX Spectrum 48K ROM under the separate notice in the emulator package's
rom/README.md.
