@design-drafts/cli 0.0.0 → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Craigory Coppola
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,83 @@
+# @design-drafts/cli
+
+Push static site previews as branches to a **design-drafts** repo, and have
+them deployed to GitHub Pages automatically.
+
+A *host* repo collects many *draft* previews. You scaffold a host once, then
+push any built static directory as a draft branch; a GitHub Actions workflow
+publishes each branch under its own path on GitHub Pages and an index site
+links them all together.
+
+## Install
+
+```sh
+# one-off
+npx @design-drafts/cli --help
+
+# or install globally for the `design-drafts` binary
+npm i -g @design-drafts/cli
+```
+
+## Commands
+
+### `design-drafts push [path]`
+
+Push a built static directory (default `.`) as a draft preview branch. This is
+the default command, so `design-drafts ./dist` works too.
+
+```sh
+design-drafts push ./dist --repo my-org/design-previews --site-name homepage-v2
+```
+
+- `--repo <org/repo>` — the host repo to push to (remembered after the first run).
+- `--site-name <name>` — branch/preview name (prompted if omitted).
+- `--prefix <prefix>` — branch prefix for previews (default `drafts/`; pass `""` to push without one).
+
+### `design-drafts init host`
+
+Scaffold a new GitHub repo configured to host draft previews (deploy workflow,
+index site, Pages setup).
+
+```sh
+design-drafts init host --repo my-org/design-previews
+```
+
+- `--private` — create the GitHub repo as private.
+- `--yes` — skip the confirmation prompt before GitHub setup.
+
+### `design-drafts init draft [directory]`
+
+Scaffold a new draft directory locally.
+
+```sh
+design-drafts init draft ./my-draft
+```
+
+### `design-drafts preview [path]`
+
+Serve a work-in-progress draft directory (default `.`) over HTTP so you can view
+it locally before pushing. The directory must contain a `design-drafts.config.json`.
+
+```sh
+design-drafts preview ./my-draft
+```
+
+- `--port <n>` — port to serve on (default `4321`; auto-increments to the next
+  free port unless you set it explicitly).
+- `--no-open` — don't open a browser, just print the URL.
+
+When a requested directory has no `index.html` (e.g. a draft whose pages are
+`about.html`, `pricing.html`, … with no home page yet), the server returns a
+generated index linking to every `.html` page in the draft so you can navigate
+without one.
+
+## Configuration
+
+Shared options (`--repo`, `--site-name`, `--template-ref`) can be supplied via
+flags, the `DESIGN_DRAFTS_*` environment variables, or a JSON config file. The
+`--repo` value is persisted to a per-user config after the first successful
+push, so subsequent runs don't need it.
+
+## License
+
+MIT

package/bin.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import('./dist/index.mjs');