@usesidekick/cli 0.1.6 → 0.2.0

package/README.md

@@ -10,15 +10,41 @@ npx @usesidekick/cli init
 
 This single command will:
 
-1. Install `@usesidekick/react`, `drizzle-orm`, `@neondatabase/serverless`, and build plugins
+1. Install `@usesidekick/react` and build plugins
 2. Configure `.babelrc` with the Sidekick JSX runtime
 3. Add webpack aliases to `next.config.js`
-4. Create a database schema and connection (`lib/db/`)
-5. Create a catch-all API route (`api/sidekick/[...action]/`)
-6. Add `SidekickBootstrap` to your app layout
-7. Analyze your components and generate `schema.json`
+4. Create a catch-all API route (`api/sidekick/[...action]/`) with JSON file storage
+5. Add `SidekickBootstrap` to your app layout
+6. Analyze your components and generate `schema.json`
 
-After init, just add your env vars and push the DB:
+After init, add your API key and start developing:
+
+```bash
+# .env.local
+ANTHROPIC_API_KEY=your_api_key
+```
+
+```bash
+npm run dev
+```
+
+Overrides are stored locally in `.sidekick/overrides.json` — no database setup required.
+
+### Using Postgres Instead
+
+For production deployments (e.g. Vercel) where the filesystem is read-only, use the `--postgres` flag to set up Drizzle + Neon:
+
+```bash
+npx @usesidekick/cli init --postgres
+```
+
+This will additionally:
+- Install `drizzle-orm`, `@neondatabase/serverless`, and `drizzle-kit`
+- Create a database schema and connection (`lib/db/`)
+- Create `drizzle.config.ts`
+- Generate an API route using `createDrizzleStorage`
+
+After init with `--postgres`:
 
 ```bash
 # .env.local
@@ -44,6 +70,7 @@ sidekick init [options]
 | Option | Default | Description |
 |--------|---------|-------------|
 | `-d, --dir <path>` | `.` | Target project directory |
+| `--postgres` | `false` | Use Drizzle + Neon Postgres instead of JSON file storage |
 
 **Detects automatically:** package manager (npm/yarn/pnpm), Next.js version, TypeScript, `src/app` vs `app` directory structure. Skips already-installed dependencies and already-configured files. Creates backups before modifying existing configs.
 
@@ -98,6 +125,26 @@ Checks for:
 
 ## What `init` Creates
 
+### Default (JSON file storage)
+
+```
+your-app/
+  .babelrc                              # JSX runtime config
+  next.config.js                        # Webpack aliases (modified)
+  src/
+    components/
+      SidekickBootstrap.tsx             # Provider + Panel wrapper
+    app/
+      layout.tsx                        # Modified to include SidekickBootstrap
+      api/sidekick/[...action]/
+        route.ts                        # Handler with JSON file storage
+    .sidekick/
+      schema.json                       # App analysis output
+      overrides.json                    # Override data (auto-created on first request)
+```
+
+### With `--postgres`
+
 ```
 your-app/
   .babelrc                              # JSX runtime config
@@ -112,18 +159,17 @@ your-app/
     app/
       layout.tsx                        # Modified to include SidekickBootstrap
       api/sidekick/[...action]/
-        route.ts                        # Thin handler (delegates to SDK)
-    sidekick/
+        route.ts                        # Handler with Drizzle storage
+    .sidekick/
       schema.json                       # App analysis output
-      overrides/                        # Generated override modules
 ```
 
 ## Requirements
 
 - **Next.js 14+** with App Router
 - **Node.js 18+**
-- **Neon** (or any PostgreSQL) for the overrides database
 - **Anthropic API key** for AI generation
+- **Neon** (or any PostgreSQL) only when using `--postgres`
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usesidekick/cli",
-  "version": "0.1.6",
+  "version": "0.2.0",
   "author": "Zach Hendershot <zhendershot@gmail.com>",
   "type": "module",
   "bin": {