papermark 0.0.1 → 0.2.0

package/README.md

@@ -1,8 +1,88 @@
-# Papermark
+# papermark
 
-This package name is reserved for the official [Papermark](https://www.papermark.com) command-line interface.
+Command-line interface for [Papermark](https://www.papermark.com).
 
-The full release is coming soon. In the meantime, see:
+Upload documents, create share links, manage datarooms, and read analytics
+from your terminal. Built to be scriptable and agent-friendly — every
+command supports `--json`, and the output contract is pinned at
+[`docs/CONTRACT_V1.md`](./docs/CONTRACT_V1.md).
 
-- [papermark.com](https://www.papermark.com) — the product
-- [github.com/mfts/papermark](https://github.com/mfts/papermark) — the Papermark application repo
+## Install
+
+```bash
+npm install -g papermark
+```
+
+## Quick start
+
+```bash
+papermark login                         # OAuth 2.1 device flow in your browser
+papermark documents list
+papermark documents upload ./deck.pdf --link
+papermark links create --document <id> --name "Acme Pitch" --password <pw>
+papermark views list --link <link-id>
+```
+
+## Authentication
+
+Four ways to authenticate, highest precedence first:
+
+1. `PAPERMARK_TOKEN` env var
+2. `PAPERMARK_CREDENTIALS_FILE` — path to a JSON file with `{token, apiUrl}`
+3. `papermark auth set --stdin` — pipe a token over stdin (CI-friendly; no
+   tempfile, no shell-history leak)
+4. Stored config (`papermark login`, or `papermark login --token pm_live_...`)
+
+Scopes supported: `documents.{read,write}`, `links.{read,write}`,
+`datarooms.{read,write}`, `analytics.read`, `visitors.read`.
+
+Tokens expire after 90 days (Stripe-CLI pattern); re-login when prompted.
+
+## Commands
+
+```
+papermark login                         Sign in via OAuth device flow
+papermark logout                        Remove the stored token
+papermark whoami                        Show the active token + API URL + source
+papermark doctor                        Scriptable preflight health check
+papermark auth export [--unmasked]      Print credentials as JSON (for CI)
+papermark auth set --stdin [--json]     Read credentials from stdin
+
+papermark documents list                List documents
+papermark documents get <id>            Fetch a single document
+papermark documents upload <file>       Upload a local file
+papermark documents delete <id>         Delete a document
+papermark documents search <query>      Search documents by name
+
+papermark links list                    List share links
+papermark links create --document <id>  Create a share link
+papermark links delete <id>             Revoke a share link
+
+papermark views list --link <link-id>   List views for a link
+
+papermark config set <key> <value>      Change stored settings (api-url, …)
+papermark config get [key]              Read stored settings
+```
+
+## Global flags
+
+- `--json` — emit machine-readable JSON (auto-enabled when stdout is piped)
+- `--dry-run` — print the HTTP request that would be sent and exit (token redacted)
+- `--no-color` — disable ANSI color (same as `NO_COLOR=1`)
+
+## Configuration
+
+- `PAPERMARK_API_URL` — defaults to `https://api.papermark.com`
+- `PAPERMARK_TOKEN` — if set, bypasses `papermark login`
+- `PAPERMARK_CREDENTIALS_FILE` — path to a `{token, apiUrl}` JSON file
+- `PAPERMARK_DEBUG=1` — log every outbound HTTP request to stderr
+
+## Exit codes
+
+`0` success · `1` api error · `2` auth error · `3` validation error ·
+`4` network error · `5` internal CLI bug. Full contract in
+[`docs/CONTRACT_V1.md`](./docs/CONTRACT_V1.md).
+
+## License
+
+MIT