Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@maayn/veld) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Veld — npm package

Contract-first, multi-stack API code generator.

Install

npm install @maayn/veld
# or
npx @maayn/veld generate

Usage

After installing, the veld CLI is available:

veld init                    # Scaffold a new project
veld generate                # Generate from veld.config.json
veld generate --dry-run      # Preview what would be generated
veld watch                   # Auto-regenerate on file changes
veld validate                # Check contracts for errors
veld clean                   # Remove generated output
veld openapi                 # Export OpenAPI 3.0 spec

How it works

This npm package includes pre-built binaries for all supported platforms. The wrapper script automatically selects the correct binary for your platform.

Supported platforms:

Linux (x64, arm64)
macOS (x64, Apple Silicon)
Windows (x64)

The package version matches the binary version, so npm install @maayn/veld@0.2.0 installs exactly version 0.2.0. No runtime downloads needed - works offline!

Alternative installation

# Go (no npm needed)
go install github.com/Adhamzineldin/Veld/cmd/veld@latest

# Homebrew
brew install veld

# pip
pip install maayn-veld

# Composer (PHP)
composer require veld-dev/veld

License

MIT

@maayn/veld