vcup Documentation

Pages

1. OverviewWhat vcup exposes (CLI upload/delete, proxy file serving), runtime assumptions (Bun CLI, Vercel serverless + Blob), and the shortest path from install to a shareable link.
2. InstallationInstall the global @maxleiter/vcup CLI with bun or npm, prerequisites, and how the published bin maps to cli.ts.
3. QuickstartConfigure ~/.vcuprc or env vars, upload one file, verify the printed proxy URL opens inline, and optional --raw output.
4. How vcup worksEnd-to-end flow: CLI streams to POST /api/upload, Vercel Blob put with random suffix, proxy slug served via /f rewrite to api/f, and optional delete path.
5. Proxy and raw URLsUpload response fields url vs raw, /f/:slug rewrite behavior, inline Content-Disposition, and when the CLI or delete flow needs the blob store URL.
6. AuthenticationShared VCUP_TOKEN secret: Bearer checks on upload and delete, client token in ~/.vcuprc or VCUP_TOKEN env, and which routes are public.
7. Deploy on VercelClone deploy button env wiring, Blob store creation, required server env vars, and post-deploy dashboard steps from README.
8. Configure the CLI~/.vcuprc JSON schema, VCUP_API_URL and VCUP_TOKEN precedence, and matching client settings to a deployed instance.
9. Custom domainPoint a subdomain at Vercel, set ~/.vcuprc url to the custom host, and how VCUP_BASE_URL affects upload response proxy URLs.
10. Upload and delete filesFile and stdin uploads, progress streaming, --raw flag, vcup rm with proxy or raw URLs, and BLOB_STORE_URL requirement for proxy deletes.
11. CLI referencevcup subcommands and flags, stdin behavior, default paste.txt filename, exit codes, help text, and Authorization/X-Filename headers sent to the API.
12. Configuration reference~/.vcuprc keys, client env vars, server env vars, VCUP_BASE_URL override, and validation errors returned by handlers.
13. API referencePOST /api/upload, DELETE /api/delete, and GET /f/:slug (via rewrite): methods, headers, status codes, JSON response shape, and streaming behavior.
14. Environment variablesServer: BLOB_READ_WRITE_TOKEN, BLOB_STORE_URL, VCUP_TOKEN, VCUP_BASE_URL. Client: VCUP_API_URL, VCUP_TOKEN, optional BLOB_STORE_URL for rm.
15. TroubleshootingSource-backed failure modes: missing config, 401/400/405/500/502 responses, directory upload rejection, proxy delete without BLOB_STORE_URL, and upstream fetch errors.
16. Local developmentRun vercel dev via package.json script, local .env from .env.example, and exercising upload, /f proxy, and delete against a dev deployment.