|
| 1 | +# Quick Share Agent Notes |
| 2 | + |
| 3 | +Quick Share is a CLI-first bridge to shared public assets in Cloudflare R2. |
| 4 | + |
| 5 | +Use it when a project needs to find shared images, PDFs, exports, handoff files, or public asset URLs without guessing bucket paths. |
| 6 | + |
| 7 | +## Preferred Workflow |
| 8 | + |
| 9 | +From any configured project: |
| 10 | + |
| 11 | +```bash |
| 12 | +quick-share where |
| 13 | +quick-share health |
| 14 | +quick-share images |
| 15 | +quick-share urls |
| 16 | +quick-share files client-name/ |
| 17 | +``` |
| 18 | + |
| 19 | +The CLI reads `.quick-share.json` from the current directory or a parent directory. If no config file exists, it falls back to `QUICK_SHARE_API_URL`. |
| 20 | + |
| 21 | +## Configure A Project |
| 22 | + |
| 23 | +If there is no hosted Quick Share Worker yet, set it up first: |
| 24 | + |
| 25 | +```bash |
| 26 | +quick-share setup-service --bucket quick-share-assets --public-url https://YOUR-PUBLIC-BUCKET.r2.dev |
| 27 | +``` |
| 28 | + |
| 29 | +This checks Wrangler, installs a local Wrangler dev dependency when needed, checks Cloudflare authentication, creates the R2 bucket, writes `wrangler.toml`, and deploys the Worker. |
| 30 | + |
| 31 | +If authentication is missing, do not guess credentials. Ask Jack to run `wrangler login` or provide a scoped `CLOUDFLARE_API_TOKEN`. |
| 32 | + |
| 33 | +From the project root: |
| 34 | + |
| 35 | +```bash |
| 36 | +quick-share init https://quick-share-api.example.workers.dev project-prefix/ |
| 37 | +``` |
| 38 | + |
| 39 | +Or configure another project from anywhere: |
| 40 | + |
| 41 | +```bash |
| 42 | +quick-share init https://quick-share-api.example.workers.dev project-prefix/ --project /path/to/project |
| 43 | +``` |
| 44 | + |
| 45 | +This writes `.quick-share.json` and adds a short Quick Share section to that project's `AGENTS.md` if needed. |
| 46 | + |
| 47 | +## Important Boundaries |
| 48 | + |
| 49 | +- Read-only: no upload, delete, move, or overwrite command exists. |
| 50 | +- Public-first: treat returned URLs as public. |
| 51 | +- Not authentication: do not use this for private client assets without adding signed URLs or auth. |
| 52 | +- Durability depends on the R2 object and public asset domain staying available. |
| 53 | + |
| 54 | +## Stable Commands |
| 55 | + |
| 56 | +- `quick-share init <api-url> [prefix] [--project <dir>]` |
| 57 | +- `quick-share setup-service [--bucket <bucket>] [--public-url <url>] [--no-deploy]` |
| 58 | +- `quick-share health` |
| 59 | +- `quick-share manifest` |
| 60 | +- `quick-share files [prefix]` |
| 61 | +- `quick-share urls [prefix]` |
| 62 | +- `quick-share images [prefix]` |
| 63 | +- `quick-share open <filename-or-index> [prefix]` |
| 64 | +- `quick-share copy <filename-or-index> [prefix]` |
| 65 | +- `quick-share where` |
0 commit comments