Loading...
Loading...
Compare original and translation side by side
undefinedundefinedundefinedundefinednode "$PLUGIN_ROOT/scripts/payload.js" $ARGUMENTShelp$PLUGIN_ROOTCLAUDE_PLUGIN_ROOTnode "$PLUGIN_ROOT/scripts/payload.js" $ARGUMENTShelp$PLUGIN_ROOT| Command | Description |
|---|---|
| Start persistent Payload server (background) |
| Graceful shutdown |
| Check if server is running + uptime |
| 命令 | 描述 |
|---|---|
| 启动持久化Payload服务器（后台运行） |
| 优雅关闭服务器 |
| 检查服务器是否运行及运行时长 |
| Flag | Default | Description |
|---|---|---|
| | HTTP port |
| | Auto-shutdown after idle (ms, default 30min) |
| env | Test database connection string |
| env | Test database port |
| 参数 | 默认值 | 描述 |
|---|---|---|
| | HTTP端口 |
| | 空闲自动关闭超时时间（毫秒，默认30分钟） |
| 环境变量 | 测试数据库连接字符串 |
| 环境变量 | 测试数据库端口 |
undefinedundefined
---
---| Command | Description |
|---|---|
| List all collection slugs, field counts, labels |
| Full field definitions (name, type, required, relationships) |
| 命令 | 描述 |
|---|---|
| 列出所有集合别名、字段数量和标签 |
| 获取完整字段定义（名称、类型、必填项、关联关系） |
undefinedundefined
---
---start| Command | Description |
|---|---|
| Find documents with filters, sort, pagination |
| Get a single document by ID |
| Count matching documents |
start| 命令 | 描述 |
|---|---|
| 使用筛选器、排序、分页查找文档 |
| 通过ID获取单个文档 |
| 统计匹配的文档数量 |
| Flag | Description | Example |
|---|---|---|
| Database: | |
| JSON filter object | |
| Sort field (prefix | |
| Max results | |
| Page number (1-indexed) | |
| Population depth (default 1) | |
| Field selection | |
| Per-request timeout (ms) | |
| 参数 | 描述 | 示例 |
|---|---|---|
| 数据库： | |
| JSON筛选对象 | |
| 排序字段（前缀 | |
| 最大结果数 | |
| 页码（从1开始） | |
| 关联数据加载深度（默认1） | |
| 字段选择 | |
| 单请求超时时间（毫秒） | |
{ "field": { "equals": "value" } }
{ "field": { "not_equals": "value" } }
{ "field": { "greater_than": 100 } }
{ "field": { "less_than": 100 } }
{ "field": { "like": "partial" } }
{ "field": { "contains": "text" } }
{ "field": { "in": ["a", "b"] } }
{ "field": { "not_in": ["a", "b"] } }
{ "field": { "exists": true } }{ "and": [{ "status": { "equals": "active" } }, { "role": { "equals": "tutor" } }] }
{ "or": [{ "status": { "equals": "active" } }, { "status": { "equals": "pending" } }] }{ "field": { "equals": "value" } }
{ "field": { "not_equals": "value" } }
{ "field": { "greater_than": 100 } }
{ "field": { "less_than": 100 } }
{ "field": { "like": "partial" } }
{ "field": { "contains": "text" } }
{ "field": { "in": ["a", "b"] } }
{ "field": { "not_in": ["a", "b"] } }
{ "field": { "exists": true } }{ "and": [{ "status": { "equals": "active" } }, { "role": { "equals": "tutor" } }] }
{ "or": [{ "status": { "equals": "active" } }, { "status": { "equals": "pending" } }] }undefinedundefined
---
---| Command | Description |
|---|---|
| Create a new document |
| Update an existing document |
| Delete a document |
--data| 命令 | 描述 |
|---|---|
| 创建新文档 |
| 更新现有文档 |
| 删除文档 |
--data| Flag | Description |
|---|---|
| JSON string with document data |
| Document ID (required for update/delete) |
| Database: |
| Population depth in response |
| Field selection in response |
| 参数 | 描述 |
|---|---|
| 包含文档数据的JSON字符串 |
| 文档ID（更新/删除时必填） |
| 数据库： |
| 响应中的关联数据加载深度 |
| 响应中的字段选择 |
undefinedundefined
---
---// Success
{ "ok": true, "data": { ... } }
// Error
{ "ok": false, "error": { "message": "...", "code": "..." } }{
"ok": true,
"data": {
"docs": [...],
"totalDocs": 42,
"limit": 10,
"totalPages": 5,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}
}// Success
{ "ok": true, "data": { ... } }
// Error
{ "ok": false, "error": { "message": "...", "code": "..." } }{
"ok": true,
"data": {
"docs": [...],
"totalDocs": 42,
"limit": 10,
"totalPages": 5,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}
}payload.js (CLI client, CommonJS, zero deps)
│
▼ HTTP
server.ts (persistent, initialized Payload instances)
│
▼ Local API
Payload CMS (dev DB + optional test DB)${PAYLOAD_CMS_HOME:-~/.payload-cms}/server.jsonpayload.js (CLI client, CommonJS, zero deps)
│
▼ HTTP
server.ts (persistent, initialized Payload instances)
│
▼ Local API
Payload CMS (dev DB + optional test DB)${PAYLOAD_CMS_HOME:-~/.payload-cms}/server.json