papermark

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Papermark (agent-first CLI)

Papermark（agent-first架构CLI）

Use this skill when the task is about Papermark dataroom discovery or analytics.

Default stance:

Prefer the
```
papermark
```
CLI, not manual browser clicking.
Prefer
```
--json
```
for machine use.
Stay read-first unless the CLI explicitly supports a mutation.
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
```
.

当任务涉及Papermark数据室的发现或分析时，可使用此技能。

默认原则：

优先使用
```
papermark
```
CLI，而非手动在浏览器中操作。
面向机器处理时优先使用
```
--json
```
格式。
除非CLI明确支持修改操作，否则优先执行只读操作。
通过遍历文件夹来梳理数据室内容，而非仅查看顶层文档。
如果
```
PATH
```
中没有
```
papermark
```
，可通过
```
npm i -g papermark-cli
```
安装官方发布的CLI。若无法全局安装npm包，可从本地代码副本通过
```
npm link
```
进行安装。

Default workflow

默认工作流程

Sanity check:
```
papermark doctor --json
```
List rooms:
```
papermark datarooms list --json
```
If needed, override the saved workspace with
```
--team-id <id>
```
Take the dataroom id from
```
datarooms list
```
and feed it into the follow-up commands
Inspect one room:
```
papermark datarooms get <id> --json
```
Read content tree:
```
papermark datarooms folders <id> --json
```
Use
```
--limit
```
for a wider summary and
```
--raw
```
only when the full nested folder tree is truly needed

Inspect access model:

papermark datarooms links <id> --json

papermark datarooms groups <id> --json

papermark datarooms permission-groups <id> --json

Inspect analytics:
```
papermark datarooms views <id> --json
```

Inspect analytics summary counts:

papermark datarooms views-count <id> --json

Inspect viewers:
```
papermark datarooms viewers <id> --json
```
Inspect room stats:
```
papermark datarooms stats <id> --json
```

Inspect export jobs:

papermark datarooms export-visits <id> --json

健康检查：
```
papermark doctor --json
```
列出数据室：
```
papermark datarooms list --json
```
如有需要，使用
```
--team-id <id>
```
覆盖已保存的工作空间
从
```
datarooms list
```
的结果中获取数据室ID，并将其用于后续命令
检查单个数据室：
```
papermark datarooms get <id> --json
```
读取内容树：
```
papermark datarooms folders <id> --json
```
使用
```
--limit
```
获取更全面的摘要，仅在确实需要完整嵌套文件夹树时使用
```
--raw
```
参数

检查访问模型：

papermark datarooms links <id> --json

papermark datarooms groups <id> --json

papermark datarooms permission-groups <id> --json

检查分析数据：
```
papermark datarooms views <id> --json
```

检查分析数据汇总统计：

papermark datarooms views-count <id> --json

检查查看者：
```
papermark datarooms viewers <id> --json
```
检查数据室统计数据：
```
papermark datarooms stats <id> --json
```

检查导出任务：

papermark datarooms export-visits <id> --json

Worked example

操作示例

If the user asks "show me the analytics and folder structure for the investor dataroom":

Run
```
papermark datarooms list --json
```
Pick the matching dataroom id from
```
data.datarooms
```
Run
```
papermark datarooms folders <id> --json
```
for the content tree

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

如果用户询问“展示投资者数据室的分析数据和文件夹结构”：

执行
```
papermark datarooms list --json
```
从
```
data.datarooms
```
中选取匹配的数据室ID
执行
```
papermark datarooms folders <id> --json
```
获取内容树

根据所需的分析数据详细程度，执行

papermark datarooms views <id> --json

papermark datarooms viewers <id> --json

或

papermark datarooms stats <id> --json

Auth

身份验证

If auth is missing:

Best interactive path:
```
papermark auth login
```
If you already have a visible Chrome session with remote debugging:
```
papermark auth login --cdp-port 9333
```

Saved local config:

printf '%s' '{"sessionToken":"...","currentTeamId":"..."}' | papermark auth set --stdin

Best ephemeral path: set

PAPERMARK_SESSION_TOKEN

and

PAPERMARK_CURRENT_TEAM_ID

If the stored team id is wrong, pass
```
--team-id <id>
```
on the dataroom command instead of recapturing auth

Avoid pasting full session tokens into logs or chat. Treat dataroom, analytics, links, groups, and viewer output as sensitive workspace data.

如果缺少身份验证：

最佳交互式方式：
```
papermark auth login
```
如果你已开启带远程调试的Chrome会话：
```
papermark auth login --cdp-port 9333
```

本地配置保存：

printf '%s' '{"sessionToken":"...","currentTeamId":"..."}' | papermark auth set --stdin

最佳临时方式：设置环境变量

PAPERMARK_SESSION_TOKEN

和

PAPERMARK_CURRENT_TEAM_ID

如果存储的团队ID有误，可在数据室命令中传入
```
--team-id <id>
```
参数，无需重新进行身份验证

请勿将完整的会话令牌粘贴到日志或聊天中。请将数据室、分析数据、链接、用户组和查看者相关输出视为敏感工作空间数据。

Important constraints

重要限制

This adapter targets a private authenticated surface, not a documented public management API.
Dataroom content is folder-first.
```
export-visits
```
currently inspects export jobs and does not yet start them.

此适配器面向私有认证接口，而非公开的已文档化管理API。
数据室内容以文件夹为核心。
```
export-visits
```
当前仅用于检查导出任务，尚不支持启动任务。

Contract essentials

核心约定

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
```

面向Agent操作时优先使用
```
--json
```
格式。
使用
```
--json
```
时，标准输出应仅包含一个JSON对象。
进度和状态信息应输出到标准错误流。
退出码：
- ```
0
```
  成功
- ```
1
```
  请求失败、上游服务失败或检查未通过
- ```
2
```
  需要身份验证/用户操作或输入无效

常见错误码：

```
AUTH_MISSING
```
```
AUTH_INVALID
```
```
NOT_FOUND
```
```
RATE_LIMITED
```
```
UPSTREAM_5XX
```
```
TIMEOUT
```
```
VALIDATION
```
```
CHECK_FAILED
```