datasette-ts 0.0.1

package/README.md

@@ -0,0 +1,86 @@
+# datasette-ts
+
+TypeScript-first Datasette-style explorer for SQLite, with local serve and Cloudflare Workers deploy.
+
+## Install
+
+```bash
+npm install -g datasette-ts
+# or
+npx datasette-ts --help
+```
+
+## Quickstart (local)
+
+```bash
+datasette-ts serve ./my.db --port 8001
+```
+
+Open `http://127.0.0.1:8001`.
+
+## Inspect a database
+
+```bash
+datasette-ts inspect ./my.db --inspect-file inspect-data.json
+```
+
+## Deploy to Cloudflare (Alchemy)
+
+Prereqs:
+- `sqlite3` available on your PATH
+- Alchemy configured and logged in (`alchemy configure`, `alchemy login`)
+
+Basic deploy (worker/D1 names default to the SQLite basename):
+
+```bash
+datasette-ts deploy cloudflare ./my.db
+```
+
+Explicit names + profile:
+
+```bash
+datasette-ts deploy cloudflare ./my.db \
+  --worker my-datasette \
+  --d1 my-datasette-db \
+  --db-name mydb \
+  --profile prod
+```
+
+Notes:
+- The CLI generates a D1 import SQL file at `.datasette-ts/imports/<db-name>.sql`.
+- Use `--no-precompute-inspect` if you want to skip inspect metadata generation.
+
+## CLI help
+
+```bash
+datasette-ts --help
+datasette-ts serve --help
+datasette-ts inspect --help
+datasette-ts deploy cloudflare --help
+```
+
+## Build
+
+```bash
+npm run build
+```
+
+Build outputs:
+- `dist/cli.js` (Node CLI entrypoint)
+- `dist/worker.js` (Cloudflare Worker entrypoint)
+
+The deploy command prefers `dist/worker.js` when present, so the published package ships a ready-to-bundle worker.
+
+## Publish
+
+```bash
+npm version <patch|minor|major>
+npm run build
+npm pack
+npm publish
+```
+
+## Status
+
+- Works: local serve, inspect data export, Cloudflare Workers deploy via Alchemy.
+- Not yet: config files, plugins, write APIs.