papermark 0.0.1 → 0.2.0

package/openai.yaml

@@ -0,0 +1,56 @@
+schema_version: v1
+name_for_human: Papermark CLI
+name_for_model: papermark
+description_for_human: Share documents, create protected links, and read analytics from your terminal.
+description_for_model: |
+  Use this action to interact with Papermark — a document-sharing and dataroom
+  service. Available workflows: upload documents, create password- or email-
+  protected share links, list viewers, read per-document and per-link analytics,
+  and manage datarooms. Every subcommand supports --json for machine-parseable
+  output. Follow the output contract in docs/CONTRACT_V1.md within this package
+  (or at https://papermark.com/docs/cli/contract).
+
+  Safety:
+  - Never upload a file the user did not explicitly reference.
+  - Never invent a password, expiry date, or email recipient — ask the user.
+  - Run `papermark doctor` before other commands if you're unsure the CLI is
+    configured. If doctor reports auth failures, surface them to the user and
+    suggest `papermark login`.
+  - Retry only on error.retryable === true and exit codes 1 or 4.
+
+auth:
+  type: user_http
+  authorization_type: bearer
+  instructions: |
+    The end user authenticates Papermark on their own machine with
+    `papermark login` (OAuth 2.1 device flow). For headless environments, they
+    may set PAPERMARK_TOKEN or pipe a token via `papermark auth set --stdin`.
+
+entry_point:
+  type: command_line
+  command: papermark
+  version_pin: ">=0.1.0 <2.0.0"
+
+commands:
+  - name: doctor
+    description: Health check. Run before other commands when unsure of state.
+    example: papermark doctor --json
+  - name: documents.list
+    description: List documents in the authenticated team.
+    example: papermark documents list --limit 25 --json
+  - name: documents.search
+    description: Substring-search documents by name.
+    example: papermark documents search "q3 deck" --json
+  - name: documents.upload
+    description: Upload a local file and create a document.
+    example: papermark documents upload ./deck.pdf --link --json
+  - name: links.create
+    description: Create a share link for a document or dataroom.
+    example: papermark links create --document <id> --password <pw> --json
+  - name: views.list
+    description: List view events for a share link.
+    example: papermark views list --link <link-id> --json
+
+contract: docs/CONTRACT_V1.md
+contact_email: support@papermark.com
+legal_info_url: https://www.papermark.com/legal

package/package.json

@@ -1,27 +1,73 @@
 {
   "name": "papermark",
-  "version": "0.0.1",
-  "description": "Papermark CLI. Full release coming soon. See https://www.papermark.com and https://github.com/mfts/papermark.",
+  "version": "0.2.0",
+  "description": "Command-line interface for Papermark — share documents, create data rooms, generate access links, and read analytics.",
   "license": "MIT",
   "homepage": "https://www.papermark.com",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/mfts/papermark.git"
+    "url": "git+https://github.com/papermark/papermark-cli.git"
   },
   "bugs": {
-    "url": "https://github.com/mfts/papermark/issues"
+    "url": "https://github.com/papermark/papermark-cli/issues"
   },
   "keywords": [
     "papermark",
-    "cli",
-    "documents",
-    "document-sharing",
     "dataroom",
-    "share-links",
-    "analytics"
+    "datarooms",
+    "data room",
+    "virtual data room",
+    "document sharing",
+    "secure file sharing",
+    "access links",
+    "analytics",
+    "cli"
   ],
+  "type": "module",
+  "bin": {
+    "papermark": "dist/index.js"
+  },
   "files": [
+    "dist",
+    "docs",
+    "skills",
+    "openai.yaml",
     "README.md",
     "LICENSE"
-  ]
+  ],
+  "engines": {
+    "node": ">=24"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsx src/index.ts",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "changeset": "changeset",
+    "version": "changeset version",
+    "release": "npm run build && changeset publish",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "commander": "^14.0.3",
+    "conf": "^13.0.1",
+    "mime-types": "^3.0.2",
+    "oauth4webapi": "^3.8.5",
+    "open": "^11.0.0",
+    "ora": "^9.4.0",
+    "prompts": "^2.4.2"
+  },
+  "devDependencies": {
+    "@changesets/changelog-github": "^0.6.0",
+    "@changesets/cli": "^2.31.0",
+    "@types/mime-types": "^3.0.1",
+    "@types/node": "^22.13.5",
+    "@types/prompts": "^2.4.9",
+    "tsup": "^8.3.5",
+    "tsx": "^4.21.0",
+    "typescript": "^5.7.2",
+    "vitest": "^4.1.5"
+  }
 }

package/skills/papermark/SKILL.md

@@ -0,0 +1,99 @@
+---
+name: papermark
+description: >
+  Upload documents to Papermark, create password- and email-protected share
+  links, read view analytics, and manage datarooms from the command line.
+  Use this Skill whenever the user says something like "share this deck",
+  "who viewed my pitch", or "make a dataroom for Acme".
+commands:
+  - papermark documents list
+  - papermark documents upload
+  - papermark links create
+  - papermark views list
+  - papermark doctor
+contract: docs/CONTRACT_V1.md
+---
+
+# Papermark CLI Skill
+
+## When to use this
+
+Papermark is a document-sharing and dataroom service. Reach for this Skill
+whenever the user asks you to:
+
+- upload a file and hand them a share link
+- check who viewed something they sent
+- organize documents into a dataroom for a deal or diligence process
+- pull analytics (views, viewers, read time) on a document or link
+
+Do **not** use this Skill for general file-sharing (use the OS), for email
+composition (use a mail Skill), or for anything outside the Papermark domain.
+
+## Setup
+
+Before running any command, verify auth is present:
+
+```bash
+papermark doctor --json
+```
+
+If `checks[*].ok` has any `false`, run `papermark login` (interactive device
+flow). In a non-interactive environment, the user must set `PAPERMARK_TOKEN`,
+pipe a token via `papermark auth set --stdin`, or point
+`PAPERMARK_CREDENTIALS_FILE` at a JSON credentials file.
+
+## Core workflows
+
+### Share a document as a protected link
+
+1. Make sure the document exists:
+   ```bash
+   papermark documents search "q3 deck" --json
+   ```
+2. If it's not there yet, upload it:
+   ```bash
+   papermark documents upload ./deck.pdf --json
+   ```
+3. Create the link, asking the user first about password, expiry, email gating,
+   and download permission. Never invent a password — either ask or generate
+   one and tell the user the exact value:
+   ```bash
+   papermark links create --document <id> --expires 2026-05-01T00:00:00Z \
+     --password "chosen-by-user" --json
+   ```
+4. Return the `url` from the response.
+
+### Answer "who viewed X"
+
+1. Resolve the doc or link by name if the user didn't give an id:
+   ```bash
+   papermark documents search "acme" --json
+   papermark links list --document <id> --json
+   ```
+2. List views:
+   ```bash
+   papermark views list --link <link-id> --json
+   ```
+
+### Create a dataroom
+
+Always `papermark doctor` first, then confirm the name with the user. Don't
+invent `internal_name` or `description` — ask or leave blank.
+
+## Output contract
+
+All commands support `--json` for machine-parseable output, auto-enabled when
+stdout is piped. The full contract — envelope shape, error codes, exit codes,
+retry semantics — is at `docs/CONTRACT_V1.md` in this package (also at
+<https://papermark.com/docs/cli/contract>).
+
+Retry policy: retry only when `error.retryable === true`. Never retry on
+`AUTH_INVALID`, `FORBIDDEN`, `VALIDATION`, or exit code 2/3/5.
+
+## Do not
+
+- Upload any file the user didn't explicitly point at.
+- Create share links for documents the user didn't name.
+- Invent passwords, expiry dates, or email recipients — ask.
+- Call tools repeatedly after an `AUTH_INVALID` — surface the error and suggest
+  `papermark login`.