Fix unpack quickstart docs and hash verification

This commit is contained in:
Samraaj Bath
2026-07-03 13:16:05 -07:00
parent 63df38105d
commit e28cc57c85
7 changed files with 45 additions and 35 deletions
+3 -3
View File
@@ -15,7 +15,7 @@ The central index for ditto.site's docs. Start here.
| --- | --- |
| Understand what ditto.site is and see it run | [Project README](../README.md) |
| Call the hosted **REST API** or **MCP** server | [Project README → Usage](../README.md#usage), [SERVICE.md](SERVICE.md) |
| Turn a clone result JSON into files on disk | [`ditto unpack` CLI](../packages/cli/README.md) |
| Turn a clone result JSON into files on disk | [Repo-local unpack CLI](../packages/cli/README.md) |
| Run the **compiler locally** from the command line | [compiler/README.md](../compiler/README.md) |
| Deploy the service | [DEPLOY.md](DEPLOY.md) |
| Read the development & evaluation method | [METHODOLOGY.md](METHODOLOGY.md) |
@@ -39,7 +39,7 @@ never commit one. Rotate a leaked key anytime from the dashboard. See
## The short version of the workflow
1. **Clone** a URL → `POST /v1/clones` (API) or `npm run clone -- <url>` (local CLI).
2. **Get the app** → unpack the result JSON with [`ditto unpack`](../packages/cli/README.md),
2. **Get the app** → unpack the result JSON with the [repo-local unpack CLI](../packages/cli/README.md),
download the `bundle?format=tgz` archive, or read files from `runs/<site>/latest/`.
3. **Preview it**`cd` into the app and `npm install && npm run dev` (or let the
local CLI do it for you with `--serve` / `--open`).
@@ -54,4 +54,4 @@ never commit one. Rotate a leaked key anytime from the dashboard. See
- [RESPONSIBLE_USE.md](RESPONSIBLE_USE.md) — acceptable-use boundaries.
- [RELEASING.md](RELEASING.md) — release process.
- [../compiler/README.md](../compiler/README.md) — local compiler commands.
- [../packages/cli/README.md](../packages/cli/README.md) — the `ditto unpack` CLI.
- [../packages/cli/README.md](../packages/cli/README.md) — the repo-local unpack CLI.
+6 -2
View File
@@ -61,16 +61,20 @@ curl -s -X POST localhost:8787/v1/clones -H 'content-type: application/json' \
```
To turn that `files` map into a project on disk, pipe the response into the
`ditto` CLI (`packages/cli`) instead of inspecting the JSON by hand:
repo-local `ditto` CLI (`packages/cli`) instead of inspecting the JSON by hand:
```bash
curl -s -X POST localhost:8787/v1/clones -H 'content-type: application/json' \
-d '{"url":"https://example.com/","options":{"mode":"single"}}' \
| npx ditto unpack - ./out
| npm run --silent unpack -- - ./out
# binary assets: set DITTO_API_URL (and DITTO_API_KEY when authenticated) so the
# CLI can fetch each file's reference URL; --no-fetch writes only the text tree.
```
The CLI package is intentionally private for now; run this command from a
checked-out `ditto.site` repo with dependencies installed. Do not use
`npx ditto` until this package is published.
## REST surface
```