papermark-cli - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

skills/papermark/assets/papermark-small.svg

+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" viewBox="0 0 24 24">
+  <rect width="24" height="24" fill="#12343B" rx="6"/>
+  <path fill="#F5F7F2" d="M7 5.5h7.2L17 8.3v10.2H7v-13Z"/>
+  <path fill="#12343B" d="M14 5.5v3h3L14 5.5Z"/>
+  <path stroke="#2CA58D" stroke-linecap="round" stroke-width="1.6" d="M9.8 12h4.4M9.8 15h3.2"/>
+</svg>

skills/papermark/assets/papermark.svg

+<svg xmlns="http://www.w3.org/2000/svg" width="96" height="96" fill="none" viewBox="0 0 96 96">
+  <rect width="96" height="96" fill="#12343B" rx="20"/>
+  <path fill="#F5F7F2" d="M28 18h29l11 11v49H28V18Z"/>
+  <path fill="#D8E2DC" d="M57 18v12h11L57 18Z"/>
+  <path stroke="#2CA58D" stroke-linecap="round" stroke-width="5" d="M38 42h20M38 54h20M38 66h13"/>
+</svg>

docs/CONTRACT_V1.md

@@ -79,2 +79,2 @@ # Papermark CLI v1 contract (agent-first)
 - `datarooms folders` returns a limited summarized view by default; `--limit` widens it and `--raw` returns the full nested payload.
-- `export-visits` currently inspects existing export jobs and does not yet trigger new exports.
+- `export-visits` is read-only: it inspects existing export jobs and does not create or start a new export.

package.json

 {
   "name": "papermark-cli",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Agent-first CLI + skill for Papermark dataroom workflows",
@@ -40,6 +40,9 @@ "license": "MIT",
     "lint": "npm run typecheck",
+    "lint:public-surface": "node scripts/public-surface-check.mjs",
+    "secret-sweep": "bash scripts/secret-sweep.sh",
+    "check:release": "npm run typecheck && npm test && npm run lint:public-surface && npm run secret-sweep",
     "pretest": "npm run build",
     "test": "tsx --test",
     "start": "node dist/cli.js",
-    "prepublishOnly": "npm test",
+    "prepublishOnly": "npm run check:release",
     "prepare": "npm run build"
@@ -46,0 +49,0 @@ },

README.md

@@ -16,3 +16,3 @@ # papermark-cli
 - dataroom stats
-- dataroom export job inspection
+- existing dataroom export job inspection
 
@@ -26,5 +26,10 @@ ## Install
 papermark --help
-npx -y papermark-cli --help
 ```
 
+Install the agent skill:
+
+```bash
+npx -y skills add -g danielgwilson/papermark-cli --skill papermark
+```
+
 Local:
@@ -94,3 +99,3 @@
 papermark datarooms stats <id> --json
-papermark datarooms export-visits <id> --json
+papermark datarooms export-visits <id> --json  # inspect existing export jobs
 ```
@@ -105,3 +110,3 @@
 - `doctor` proves auth, team resolution, and dataroom listing. It is a fast sanity check, not a full sweep of every route.
-- `export-visits` currently inspects existing export jobs via a GET route. Triggering new export jobs can be added later if the hosted behavior proves stable enough.
+- `export-visits` is read-only: it inspects existing export jobs via a GET route. It does not create or start a new export.
 - Runtime outputs can contain sensitive dataroom structure, analytics, access-control, and viewer information. Treat command output as private workspace data.
@@ -108,0 +113,0 @@

skills/papermark/agents/openai.yaml

 interface:
   display_name: "Papermark"
   short_description: "Inspect Papermark datarooms and analytics."
-  default_prompt: "Use $papermark to inspect datarooms, folders, viewers, views, and export-visits jobs."
+  icon_small: "./assets/papermark-small.svg"
+  icon_large: "./assets/papermark.svg"
+  brand_color: "#334155"
+  default_prompt: "Use $papermark to inspect Papermark datarooms, folders, links, access groups, viewers, views, stats, and existing export-visits jobs."
 
 policy:
   allow_implicit_invocation: true

skills/papermark/SKILL.md

 ---
 name: papermark
-description: Use this skill whenever you need to inspect Papermark datarooms via the agent-first `papermark` CLI. Triggers include listing datarooms, inspecting one dataroom, reading folder structures, checking links, groups, permission groups, viewers, views, stats, or export-visits jobs.
+description: Use this skill whenever you need to inspect Papermark datarooms via the agent-first `papermark` CLI. Triggers include listing datarooms, inspecting one dataroom, reading folder structures, checking links, groups, permission groups, viewers, views, stats, or existing export-visits jobs.
 ---
@@ -16,2 +16,3 @@
 - Model dataroom contents through folder traversal, not just top-level documents.
+- If `papermark` is missing from `PATH`, install the published CLI with `npm i -g papermark-cli`. If global npm install is unavailable, install from a local checkout with `npm link`.
 
@@ -32,4 +33,13 @@ ## Default workflow
 - Inspect room stats: `papermark datarooms stats <id> --json`
-- Inspect export jobs: `papermark datarooms export-visits <id> --json`
+- Inspect existing export jobs: `papermark datarooms export-visits <id> --json`
 
+## Worked example
+
+If the user asks "show me the analytics and folder structure for the investor dataroom":
+
+1. Run `papermark datarooms list --json`
+2. Pick the matching dataroom id from `data.datarooms`
+3. Run `papermark datarooms folders <id> --json` for the content tree
+4. Run `papermark datarooms views <id> --json`, `papermark datarooms viewers <id> --json`, or `papermark datarooms stats <id> --json` depending on the level of analytics detail needed
+
 ## Auth
@@ -52,6 +62,21 @@
 - Dataroom content is folder-first.
-- `export-visits` currently inspects export jobs and does not yet start them.
+- `export-visits` is read-only: it inspects existing export jobs and does not create or start a new export.
 
-## Contract
+## Contract essentials
 
-Stable JSON behavior is documented in `docs/CONTRACT_V1.md`.
+- Prefer `--json` for agent work.
+- With `--json`, stdout should contain exactly one JSON object.
+- Progress and status belong on stderr.
+- Exit codes:
+  - `0` success
+  - `1` request failure, upstream failure, or failed checks
+  - `2` auth/user action required or invalid input
+- Common error codes:
+  - `AUTH_MISSING`
+  - `AUTH_INVALID`
+  - `NOT_FOUND`
+  - `RATE_LIMITED`
+  - `UPSTREAM_5XX`
+  - `TIMEOUT`
+  - `VALIDATION`
+  - `CHECK_FAILED`

No alert changes

Improved metrics

Total package byte prevSize

43862

5.52%

Number of package files

14

16.67%

Number of lines in readme file

121

4.31%

No dependency changes