Get started here

Use the reference toolchain from the monorepo today. Packages are not on the public npm registry yet — clone the repo and run the CLI locally. Requirements: Node.js 20+, Git.

1. Clone and install

git clone https://github.com/eudameron/aiparlance.git
cd aiparlance
npm ci
npm run build

This builds @aiparlance/parser, validator, cli, and the Preview emitters (sql, openapi, typescript, go, mysql, workers, python, php, docs, tests).

2. Run the CLI

The binary lives at packages/cli/dist/cli.js after build:

node packages/cli/dist/cli.js --help

Command	What it does
`aip parse <file.aip>`	Print the AST as JSON
`aip validate <file.aip>`	Semantic checks (MUST rules) — Core + Infra + Security + Behavior
`aip emit sql <file.aip>`	PostgreSQL DDL (+ indexes / seeds when present)
`aip emit openapi <file.aip>`	OpenAPI 3.0.3 JSON
`aip emit typescript <file.aip>`	TypeScript interfaces + type guards
`aip emit go <file.aip>`	Go structs + thin handlers + auth middleware
`aip emit mysql <file.aip>`	MySQL DDL (`database mysql`)
`aip emit workers <file.aip>`	Jobs / queues stubs
`aip emit python <file.aip>`	Python dataclasses
`aip emit php <file.aip>`	PHP classes
`aip emit docs <file.aip>`	Markdown API reference
`aip emit tests <file.aip>`	CRUD test fixtures

Try the minimal example

node packages/cli/dist/cli.js validate examples/minimal.aip
node packages/cli/dist/cli.js emit sql examples/minimal.aip
node packages/cli/dist/cli.js emit openapi examples/minimal.aip
node packages/cli/dist/cli.js emit typescript examples/minimal.aip
node packages/cli/dist/cli.js emit go examples/minimal.aip

Write output to a file:

node packages/cli/dist/cli.js emit sql examples/minimal.aip > /tmp/minimal.sql
node packages/cli/dist/cli.js emit openapi examples/minimal.aip > /tmp/minimal.openapi.json
node packages/cli/dist/cli.js emit typescript examples/minimal.aip > /tmp/minimal.ts
node packages/cli/dist/cli.js emit go examples/minimal.aip > /tmp/minimal.go

Full CRUD walkthrough (entities, policies, API, seeds, emit): CRUD walkthrough.

Blog CRUD happy path (TypeScript + SQL + OpenAPI)

export DATABASE_URL=postgres://postgres:postgres@127.0.0.1:5432/aiparlance
export AIP_JWT_SECRET=dev-secret
node packages/cli/dist/cli.js validate examples/blog-crud.aip
node packages/cli/dist/cli.js emit sql examples/blog-crud.aip | psql "$DATABASE_URL"
node packages/cli/dist/cli.js emit typescript examples/blog-crud.aip > /tmp/blog-app.ts
# npm i zod pg jose  (peers for the generated app)
npx tsx -e "import { listenCrudApp } from '/tmp/blog-app.ts'; listenCrudApp()"

GET /v1/posts is public; mutating routes need Authorization: Bearer <JWT> (signCrudToken in the generated file). Without DATABASE_URL the app stays in-memory.

3. Write your own `.aip`

Every v0.1 spec needs one app block first, then entity / crud / validation (Core). See Syntax and examples/.

app Demo @0.1 {
  database postgres
}

entity User {
  name: string required
  email: email required unique
}

crud User

Save as my-app.aip, then:

node packages/cli/dist/cli.js validate my-app.aip
node packages/cli/dist/cli.js emit sql my-app.aip

Richer examples (blog-crud.aip, crm-reference.aip, ops-reference.aip, inventory-crud.aip) include Infra / Security / Behavior and parse + validate with the full v0.1 toolchain. Use mysql-minimal.aip for aip emit mysql.

4. Run the test suite

From the repo root:

npm test

This typechecks/builds workspaces and runs Vitest (parser, validator, emitters, CLI, and examples CI). Examples-only:

npm run check:examples

Typecheck without tests:

npm run typecheck

5. What ships vs what is preview

Status	Targets
Preview (in monorepo)	PostgreSQL, MySQL, OpenAPI 3, TypeScript, Go, Python, PHP, Workers, Docs, Tests
Phase D focus	Deepen TypeScript, OpenAPI, PostgreSQL → runnable happy path; then playground + npm
Illustrative only	Marketing site playground — not the official packages

Optional: docs and site locally

# Docs (Mintlify)
cd docs && npx mintlify dev

# Marketing site
cd site && npm ci && npm run build:prod

Overview

Examples

Emitters

Reference

Domains

AI

Get started here

Get started here

1. Clone and install

2. Run the CLI

Try the minimal example

Blog CRUD happy path (TypeScript + SQL + OpenAPI)

3. Write your own `.aip`

4. Run the test suite

5. What ships vs what is preview

Optional: docs and site locally

​Get started here

​1. Clone and install

​2. Run the CLI

​Try the minimal example

​Blog CRUD happy path (TypeScript + SQL + OpenAPI)

​3. Write your own .aip

​4. Run the test suite

​5. What ships vs what is preview

​Optional: docs and site locally

Get started here

1. Clone and install

2. Run the CLI

Try the minimal example

Blog CRUD happy path (TypeScript + SQL + OpenAPI)

3. Write your own `.aip`

4. Run the test suite

5. What ships vs what is preview

Optional: docs and site locally