vasp-cli 0.1.1 → 0.1.3

package/README.md

@@ -1,6 +1,6 @@
 # vasp-cli
 
-The official CLI for [Vasp](https://github.com/amirreza-alibeigi/vasp) — a declarative full-stack framework for Vue developers powered by Bun + Elysia.
+The official CLI for [Vasp](https://github.com/vasp-framework/vasp) — a declarative full-stack framework for Vue developers powered by Bun + Elysia.
 
 ## Installation
 
@@ -12,45 +12,48 @@ bun install -g vasp-cli
 npm install -g vasp-cli
 ```
 
-> **Requires [Bun](https://bun.sh) ≥ 1.0**
+> **Requires [Bun](https://bun.sh) >= 1.0**
 
-## Usage
+## Commands
 
-```
-vasp <command> [options]
+### `vasp new <project-name>`
+
+Scaffold a new Vasp project.
+
+```bash
+vasp new my-app                       # JavaScript + SPA (default)
+vasp new my-app --typescript          # TypeScript
+vasp new my-app --ssr                 # SSR via Nuxt 4
+vasp new my-app --ssg                 # Static Site Generation via Nuxt 4
+vasp new my-app --ssr --typescript    # SSR + TypeScript
+vasp new my-app --starter=todo        # Use a starter template
+vasp new my-app --no-install          # Skip bun install
 ```
 
-## Commands
+**Starters:** `minimal`, `todo`, `todo-auth-ssr`
 
-### `vasp new <project-name>`
+### `vasp start`
 
-Scaffold a new Vasp project from your `main.vasp` config.
+Start the dev servers (backend + frontend) concurrently with color-prefixed output.
 
 ```bash
-vasp new my-app                        # JavaScript + SPA (default)
-vasp new my-app --typescript           # TypeScript
-vasp new my-app --ssr                  # SSR via Nuxt 4
-vasp new my-app --ssg                  # Static Site Generation via Nuxt 4
-vasp new my-app --ssr --typescript     # SSR + TypeScript
-vasp new my-app --no-install           # Skip bun install
+cd my-app && vasp start
 ```
 
-**Options:**
+### `vasp build`
+
+Build for production — compiles the Elysia backend with Bun and the frontend with Vite or Nuxt.
 
-| Flag | Alias | Description |
-|---|---|---|
-| `--typescript` | `--ts` | Enable TypeScript (default: JavaScript) |
-| `--ssr` | | Enable SSR mode via Nuxt 4 (default: SPA) |
-| `--ssg` | | Enable Static Site Generation via Nuxt 4 |
-| `--no-install` | | Skip running `bun install` after scaffolding |
+```bash
+cd my-app && vasp build
+```
 
 ### `vasp migrate-to-ts`
 
-Migrate an existing JavaScript Vasp project to TypeScript in place.
+Convert an existing JavaScript Vasp project to TypeScript in-place.
 
 ```bash
-cd my-app
-vasp migrate-to-ts
+cd my-app && vasp migrate-to-ts
 ```
 
 - Sets `typescript: true` in `main.vasp`
@@ -59,63 +62,55 @@ vasp migrate-to-ts
 
 ### `vasp enable-ssr`
 
-Enable SSR on an existing SPA project.
+Switch an existing SPA project to SSR (Nuxt 4).
 
 ```bash
-cd my-app
-vasp enable-ssr
+cd my-app && vasp enable-ssr
 ```
 
 - Patches `ssr: false` → `ssr: true` in `main.vasp`
-- Regenerates the project with Nuxt 4 SSR files
+- Regenerates the Nuxt 4 frontend files
 
-### `vasp start` *(coming soon)*
-
-Start the development server.
-
-### `vasp build` *(coming soon)*
+## Example `main.vasp`
 
-Build the project for production.
+```
+app TodoApp {
+  title: "Todo App"
+  db: Drizzle
+  ssr: false
+  typescript: true
+}
 
----
+auth UserAuth {
+  userEntity: User
+  methods: [usernameAndPassword]
+}
 
-## Example `main.vasp`
+route HomeRoute {
+  path: "/"
+  to: HomePage
+}
 
-```vasp
-app MyApp {
-  database: postgres
-  auth: true
-  typescript: false
-  ssr: false
+page HomePage {
+  component: import Home from "@src/pages/Home.vue"
 }
 
-model User {
-  id:        Int     @id @default(autoincrement())
-  email:     String  @unique
-  createdAt: DateTime @default(now())
+crud Todo {
+  entity: Todo
+  operations: [list, create, update, delete]
 }
 
-crud User {
-  operations: [create, read, update, delete]
+query getTodos {
+  fn: import { getTodos } from "@src/queries.ts"
+  entities: [Todo]
   auth: true
 }
-```
-
-## Generated Project Structure
 
-```
-my-app/
-├── main.vasp          # Single source of truth
-├── server/
-│   ├── index.ts       # Elysia + Bun HTTP server
-│   ├── db/            # Drizzle ORM setup
-│   └── routes/        # Auto-generated CRUD routes
-├── src/               # Vue 3 frontend (SPA) or Nuxt 4 (SSR)
-│   ├── components/
-│   ├── pages/
-│   └── composables/
-├── package.json
-└── bunfig.toml
+action createTodo {
+  fn: import { createTodo } from "@src/actions.ts"
+  entities: [Todo]
+  auth: true
+}
 ```
 
 ## License