syzs-cli
v0.8.2
Published
CLI to package, version and share integration knowledge — with agent-assisted test authoring and deterministic test execution.
Readme
SYZYGY
CLI to package, version and share integration knowledge — with agent-assisted test authoring and deterministic test execution.
Requires: Node.js >= 20
Install
npm install -g syzs-cliCommands
| Command | Description |
|---|---|
| syz run | Execute test scenarios against a live environment |
| syz lint | Pre-flight validation — checks scenarios, agents, templates, and env config before running |
| syz install | Install shared plugins from a git repository |
| syz generate | Generate plugin artifacts from an OpenAPI spec, Postman collection, or interactive prompt |
| syz init | Initialise project structure and generate AI tool context files |
| syz rtm | Requirements traceability matrix — trace scenarios to requirements and coverage gaps |
Quick Start
# Initialise a new project
syz init
# Validate scenarios before running
syz lint --env local
# Run scenarios and view results
syz run --suite .syz/scenarios/e2e/ --env local
syz run --suite .syz/scenarios/ --env staging --run-name release-v1
# Check requirements traceability
syz rtm --lastrun
# Install a shared plugin
syz install https://github.com/acme/[email protected] --plugin payments
# Generate a plugin from OpenAPI spec
syz generate plugin --name payments --from openapi:./api-spec.yaml
# Generate a plugin interactively
syz generate plugin --name paymentsFeatures
- Versioned plugins — Package integration knowledge into reusable, git-hosted plugins
- Schema-based knowledge layer — Capture requirements, behaviours, and test coverage via YAML specs
- Agent-assisted authoring — Generate test scenarios from OpenAPI, Postman, or interactive prompts
- Deterministic execution — Execute the same scenario identically across environments; audit every step via ledger
- Traceability —
syz rtmtraces scenarios to requirements and identifies coverage gaps
Notice & License
SYZYGY's AI features ({{ ai: ... }} resolvers and type: ai assertions) are non-deterministic and send data to a third-party model provider — review AI-generated values before relying on them. syz run executes real calls against live systems; there is no sandbox. After syz init, see .syz/dossier/SYZ-NOTICE.md for the full notice.
The syz CLI is proprietary software "AS IS", without warranty. Governed by LICENSE — your authored content (plugins, scenarios, results) remains yours to use, commit, and share.
