@doubledigit/cli 0.2.0 → 0.2.1

package/README.md

@@ -0,0 +1,102 @@
+# @doubledigit/cli
+
+CLI for Double Digit local setup, project bootstrapping, extension management, and database workflows.
+
+Double Digit is a pluggable Next.js/Payload developer control plane. The CLI is the supported command surface for creating a new Double Digit project and managing an existing local workspace.
+
+## Usage
+
+Run the published package directly:
+
+```bash
+npx @doubledigit/cli init my-project
+pnpm dlx @doubledigit/cli init my-project
+```
+
+Inside a Double Digit project, use the repo-local shortcut:
+
+```bash
+pnpm dd doctor
+pnpm dd onboard
+pnpm dd run
+```
+
+If installed globally, the binary is available as `dd`:
+
+```bash
+dd doctor
+dd onboard
+dd run
+```
+
+## Requirements
+
+- Node.js 20 or newer
+- pnpm 9 or newer
+
+Enable pnpm through Corepack when needed:
+
+```bash
+corepack enable
+```
+
+## Core Commands
+
+```bash
+dd init <project-name>      # scaffold a new Double Digit project
+dd doctor                   # check local prerequisites and project health
+dd onboard                  # prepare env, dependencies, DB, migrations, and types
+dd run                      # bootstrap the runtime DB and start the app
+dd db status                # inspect migration state
+dd db migrate               # run migrations
+dd db create <target> <name> # create a migration for shared or micro-app schema
+dd add <source>             # install an extension
+dd sync                     # regenerate workspace registries
+dd list                     # list discovered micro-apps
+dd enable <name>            # enable a micro-app
+dd disable <name>           # disable a micro-app
+dd remove <name>            # remove a micro-app package and wiring
+dd reconcile                # detect registry, lock file, and package drift
+dd marketplace <subcommand> # manage marketplace registrations
+dd browse                   # browse marketplace extensions
+```
+
+`add` is also available as `install`, and `remove` is also available as `uninstall`.
+
+## New Project Bootstrap
+
+```bash
+npx @doubledigit/cli init my-project --yes
+cd my-project
+pnpm dd run
+```
+
+Useful `init` options:
+
+- `--yes` skips prompts and uses defaults.
+- `--run` bootstraps and starts the app after scaffolding.
+- `--skip-install` skips dependency installation.
+- `--no-git` removes the cloned `.git` directory from the generated project.
+
+## Existing Project Setup
+
+Use `onboard` for setup-only work:
+
+```bash
+pnpm dd onboard
+```
+
+Use `run` when you want the CLI to prepare the runtime database and then start the app:
+
+```bash
+pnpm dd run
+```
+
+Leave `DATABASE_URL` empty in `apps/main-app/.env` to use the default CLI-managed embedded PostgreSQL flow. Provide `DATABASE_URL` through the environment or `.env` when using your own PostgreSQL instance.
+
+## Links
+
+- Repository: https://github.com/crystalphantom/double-digit
+- Issues: https://github.com/crystalphantom/double-digit/issues
+- Getting started: https://github.com/crystalphantom/double-digit/blob/main/docs/getting-started.md
+- Architecture: https://github.com/crystalphantom/double-digit/blob/main/docs/architecture.md

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doubledigit/cli",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "private": false,
   "description": "CLI for Double Digit local setup and extension management.",
   "license": "MIT",
@@ -25,7 +25,8 @@
     "dd": "./dist/index.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "exports": {
     ".": {