nexudus

Nexudus CLI Agent 技能

你可以通过 nexudus CLI 工具管理 Nexudus 共享办公空间。本技能将指导你如何进行身份验证、查询数据，以及通过 Nexudus 平台 API 执行 CRUD 操作。

Agent 不变量

1. 每次 CLI 调用都必须使用 --agent 标志。 这会返回适合机器处理的结构化 JSON 信封。

2. 执行操作前，先解析 JSON 信封。 信封的结构如下：

   {
     "ok": true,
     "data": { ... },
     "summary": "Human-readable summary",
     "breadcrumbs": ["entity", "action"],
     "meta": { "total": 10, "page": 1, "pageSize": 25, "totalPages": 1 }
   }
   

3. 先检查 ok。 如果 ok 为 false，请读取 summary 中的错误消息并停止。

4. 切勿通过交互方式向用户索要凭据。 如果 ok 为 false 且出现身份验证错误，请告知用户手动运行 nexudus login。

5. 删除命令需使用 --yes 或 -y 跳过交互式确认提示。

6. 需要脚本使用原始数据时，使用 --json。 需要包含摘要的信封时，使用 --agent。

7. 列表响应不包含集合属性。 只有在按 ID 获取单个实体（get <id>）时，API 才会返回列表／数组字段（例如 Tariffs、Teams、LinkedResources）。列表命令会返回不包含这些字段的简化投影。如果需要读取或验证集合属性，请务必先获取单个实体。

8. 使用当前用户的业务、货币、国家／地区和时区默认值。 创建或更新需要业务（地点）、货币、国家／地区或时区的实体之前，请运行 nexudus whoami --agent，并使用响应中的默认值：

   • DefaultBusinessId — 创建与地点相关的实体时，用作 --business。
   • DefaultCurrencyId — 需要货币时，用作 --currency-id。
   • DefaultCurrencyCode — 用于显示／参考。
   • DefaultCountryId — 需要国家／地区时，用作 --country-id。
   • DefaultSimpleTimeZoneId — 需要时区时，用作 --timezone-id。

   只有当用户明确表示要覆盖默认值时，才询问他们指定这些值。

9. 对于列表属性，优先使用 --{list}，而非 --added-{list}／--removed-{list}。 设置列表字段（例如 --tariffs、--resource-types、--teams、--linked-resources）时，使用普通的 --{list} 标志，将整个列表替换为提供的值。只有在需要从现有列表中添加或移除单个项，且不更改其余内容时，才使用 --added-{list} 或 --removed-{list}。本意是设置完整列表，却传入 --added-{list} 是常见错误，会导致旧条目残留。

10. 不确定某个字段时，先运行 --help。 如果本技能文件未完整说明某个实体或选项，请运行 nexudus <entity> <command> --help，了解可用选项及其说明，然后再构造命令。

11. DateTime 值必须使用 ISO 8601 格式。 所有 DateTime 字段都必须采用 YYYY-MM-DDTHH:MM:SSZ 格式（UTC），例如 2025-06-15T09:00:00Z。切勿使用 June 15, 2025、15/06/2025 等区域格式或 Unix 时间戳。实体参考文件会为 DateTime 选项标注 (DateTime)，便于识别。

12. 每次 CLI 调用都必须传入遥测上下文标志。 有关所需标志及其值的生成方法，请参阅下方的遥测上下文部分。

初始化

首先运行诊断，确认 CLI 已就绪：

nexudus doctor --agent

此命令会返回 CLI 版本、.NET 运行时、操作系统、凭据状态、配置文件位置、API 连接状态以及所有可用命令。继续之前，请检查 data.CredentialsStored 和 data.ApiStatus。

如果缺少凭据，请告知用户：

运行 nexudus login，使用你的 Nexudus 账户进行身份验证。

CLI 自省

随时查看可用命令和选项：

nexudus --help
nexudus businesses --help
nexudus products --help
nexudus config --help

每个命令也支持使用 --help 查看详细的选项信息：

nexudus businesses update --help
nexudus products create --help

命令参考

身份验证

命令	描述
nexudus login	进行身份验证（交互式提示）
nexudus logout	清除已存储的凭据
nexudus whoami	显示当前已验证身份的用户

配置

命令	描述
nexudus config get <key>	读取配置值
nexudus config set <key> <value>	设置配置值

配置键：base-url

诊断

nexudus doctor --agent

全局标志

标志	描述
--agent	包含摘要的 JSON 信封（请使用此标志）
--json	原始 JSON 信封
--md	Markdown 输出
--base-url <url>	覆盖 API 基础 URL
--trace-id <uuid>	用于关联单个任务中命令的跟踪 ID
--caller <name>	调用 Agent 的名称（例如：copilot、claude）
--intent <text>	对用户请求的一行摘要
--attempt <n>	此命令的尝试次数（1 = 首次尝试）

遥测上下文

Agent 发起的每次 CLI 调用必须包含四个遥测标志，以便跟踪、关联和调试命令使用情况。

标志	设置方式	示例
--trace-id	每个用户任务生成一个 UUID，并在该任务的每次 CLI 调用中重复使用。	--trace-id a1b2c3d4-e5f6-7890-abcd-ef1234567890
--caller	用于标识 Agent 的固定字符串。使用小写的 Agent 名称。	--caller copilot
--intent	简短概述用户的请求内容（≤120 个字符）。同一任务中的所有调用都使用相同内容。空格需加引号。	--intent "list all products for the London business"
--attempt	从 1 开始。因失败而重试同一命令时递增。执行不同命令时重置为 1。	--attempt 1

示例：包含遥测信息的完整调用

nexudus products list --agent --trace-id a1b2c3d4-e5f6-7890-abcd-ef1234567890 --caller copilot --intent "list all products" --attempt 1

规则

• 同一用户任务／对话轮次中的每次调用都使用相同的 --trace-id。
• 仅在失败后重试完全相同的命令时，才递增 --attempt。
• Agent 的整个生命周期中，--caller 必须保持不变（例如：copilot、claude、custom-bot）。
• --intent 应为用户的原始请求，而不是 CLI 命令说明。
• 设置 --agent 并提供遥测标志时，响应信封会包含 telemetry 对象，其中含有 traceId、durationMs 和 attempt，供你参考。

输出信封

使用 --agent 或 --json 时，所有命令都会生成 JSON 信封：

{
  "ok": true,
  "data": [ ... ],
  "summary": "Found 3 businesses (page 1/1)",
  "breadcrumbs": ["businesses", "list"],
  "meta": {
    "total": 3,
    "page": 1,
    "pageSize": 25,
    "totalPages": 1
  }
}

• ok：成功时为 true，失败时为 false。
• data：响应负载——单实体操作时为对象，列表操作时为数组，某些失败情况下为 null。
• summary：便于阅读的结果说明。
• breadcrumbs：生成输出的命令路径（例如：["products", "create"]）。
• meta：列表操作的分页元数据（仅列表命令中提供）。

PII 脱敏

CLI 会在非交互模式下自动对个人身份信息进行脱敏。此行为由结构决定，不受调用方标志控制。

• 在重定向输出或 Agent 输出中，PII 值会显示为确定性令牌，例如 «PII:EMAIL:a3f2b1c9»。
• 对同一台机器上的相同源值，令牌保持稳定。
• 你可以将令牌传回创建／更新命令；CLI 会在调用 API 前将其解析为真实值。
• 非交互式响应包含 piiRedaction 和 piiRedactionReason，以便验证模式。

令牌往返示例：

nexudus coworkers update 12345 --email "«PII:EMAIL:a3f2b1c9»" --agent

不要将令牌视为真实值，也不要尝试反向还原。

错误封装

{
  "ok": false,
  "data": null,
  "summary": "Not logged in. Run 'nexudus login' first.",
  "breadcrumbs": ["businesses", "list"]
}

决策树

“查找并显示一项业务”

1. nexudus businesses list --agent（或使用 --name "value" 等筛选选项进行搜索）
2. 解析 data 数组，找到目标业务
3. 使用 nexudus businesses get <id> --agent 获取完整详情

“创建一个实体”

1. 首先查找业务 ID：nexudus businesses list --agent
2. nexudus <entity> create --name "Day Pass" --price 25.00 --business <businessId> --agent
3. 确认 ok 为 true，读取 data.Id 获取新实体 ID

“更新实体属性”

1. 使用 nexudus <entity> get <id> --agent 确认实体存在
2. nexudus <entity> update <id> --<property> <value> --agent
3. 检查返回的 data，确认更新成功

“删除一个实体”

1. 使用 nexudus <entity> get <id> --agent 确认实体存在
2. nexudus <entity> delete <id> --yes --agent
3. 确认 ok 为 true

“列出特定业务的实体”

1. nexudus <entity> list --business <businessId> --agent
2. 如需分页，添加 --page-number N --page-size M

“对实体运行实体命令”

1. 使用 nexudus <entity> commands --agent 查找可用命令
2. nexudus <entity> run-command <commandKey> <id1,id2> --agent
3. 如果命令需要参数，使用 -p Name=Value 添加

“检查 CLI 健康状态”

1. nexudus doctor --agent
2. 确认 data.CredentialsStored 为 true
3. 确认 data.ApiStatus 为 "OK"

特定实体的工作流（例如，向产品添加通行证、设置定价）记录在 references/entities/ 下对应的实体参考文件中。

错误处理

错误	含义	操作
ok: false，summary 包含 "Not logged in"	未存储凭据	告知用户运行 nexudus login
ok: false，summary 包含 "Unauthorized"	凭据无效	告知用户再次运行 nexudus login
ok: false，summary 包含 "Forbidden"	权限不足	告知用户其 API 权限不足
ok: false，summary 包含 "not found"	实体不存在	检查 ID，然后重试
ok: false，summary 包含 "Failed to create"	创建验证错误	检查必填字段（名称、业务、价格）
非零退出代码	命令失败	阅读 stderr 或 JSON 封装以了解详情

实体索引

使用实体前，请加载其参考文件以了解完整详情（命令、选项、关键字段、枚举值和特定实体的工作流）。

实体	CLI 命令	操作	参考
AccessToken	accesstokens	列表、获取、创建、更新、删除	accesstokens.md
AdminAgentMessage	adminagentmessages	列表、获取、创建、更新、删除	adminagentmessages.md
AdminAgentSession	adminagentsessions	列表、获取、创建、更新、删除	adminagentsessions.md
AdminAgentSessionParticipant	adminagentsessionparticipants	列表、获取、创建、更新、删除	adminagentsessionparticipants.md
AiChannelSession	aichannelsessions	列表、获取、创建、更新、删除	aichannelsessions.md
Application	applications	列表、获取、创建、更新、删除	applications.md
AudioFile	audiofiles	列表、获取、创建、更新、删除	audiofiles.md
AuditTrailEntry	audittrailentries	列表、获取	audittrailentries.md
AutomationTile	automationtiles	列表、获取、创建、更新、删除	automationtiles.md
AutomationTileAudit	automationtileaudits	列表、获取、创建、更新、删除	automationtileaudits.md
BasketSession	basketsessions	列表、获取、创建、更新、删除	basketsessions.md
BlogCategory	blogcategories	列表、获取、创建、更新、删除	blogcategories.md
BlogPost	blogposts	列表、获取、创建、更新、删除	blogposts.md
BlogPostComment	blogpostcomments	列表、获取、创建、更新、删除	blogpostcomments.md
Booking	bookings	列表、获取、创建、更新、删除	bookings.md
BookingAvailabilityException	bookingavailabilityexceptions	列表、获取、创建、更新、删除	bookingavailabilityexceptions.md
BookingNote	bookingnotes	列表、获取、创建、更新、删除	bookingnotes.md
BookingProduct	bookingproducts	列表、获取、创建、更新、删除	bookingproducts.md
BookingVisitor	bookingvisitors	列表、获取、创建、更新、删除	bookingvisitors.md
Business	businesses	列表、获取、更新	businesses.md
BusinessAnnouncement	businessannouncements	列表、获取、创建、更新、删除	businessannouncements.md
BusinessBackgroundJob	businessbackgroundjobs	列表、获取	businessbackgroundjobs.md
BusinessCharge	businesscharges	列表、获取、创建、更新、删除	businesscharges.md
BusinessDomain	businessdomains	列表、获取、创建、更新、删除	businessdomains.md
BusinessRedirection	businessredirections	列表、获取、创建、更新、删除	businessredirections.md
BusinessSetting	businesssettings	列表、获取、创建、更新、删除	businesssettings.md
BusinessTimeSlot	businesstimeslots	列表、获取、创建、更新、删除	businesstimeslots.md
CalendarEvent	calendarevents	列表、获取、创建、更新、删除	calendarevents.md
CalendarEventCategory	calendareventcategories	列表、获取、创建、更新、删除	calendareventcategories.md
CancelledBooking	cancelledbookings	列表、获取、创建、更新、删除	cancelledbookings.md
CannedResponse	cannedresponses	列表、获取、创建、更新、删除	cannedresponses.md
Charge	charges	列表、获取、创建、更新、删除	charges.md
ChatRoom	chatrooms	列表、获取、创建、更新、删除	chatrooms.md
ChatUserMessage	chatusermessages	列表、获取、创建、更新、删除	chatusermessages.md
Checkin	checkins	列表、获取、创建、更新、删除	checkins.md
CommunityGroup	communitygroups	列表、获取、创建、更新、删除	communitygroups.md
CommunityMessage	communitymessages	列表、获取、创建、更新、删除	communitymessages.md
CommunityMessageLike	communitymessagelikes	列表、获取、创建、更新、删除	communitymessagelikes.md
CommunityMessageRead	communitymessagereads	列表、获取、创建、更新、删除	communitymessagereads.md
CommunityPerk	communityperks	列表、获取、创建、更新、删除	communityperks.md
CommunityThread	communitythreads	列表、获取、创建、更新、删除	communitythreads.md
CommunityThreadFile	communitythreadfiles	列表、获取、创建、更新、删除	communitythreadfiles.md
CommunityThreadFollow	communitythreadfollows	列表、获取、创建、更新、删除	communitythreadfollows.md
CommunityThreadLike	communitythreadlikes	列表、获取、创建、更新、删除	communitythreadlikes.md
CommunityThreadMute	communitythreadmutes	列表、获取、创建、更新、删除	communitythreadmutes.md
CommunityThreadRead	communitythreadreads	列表、获取、创建、更新、删除	communitythreadreads.md
ContractContact	contractcontacts	列表、获取、创建、更新、删除	contractcontacts.md
ContractDeposit	contractdeposits	列表、获取、创建、更新、删除	contractdeposits.md
ContractPausedPeriod	contractpausedperiods	列表、获取、创建、更新、删除	contractpausedperiods.md
ContractProduct	contractproducts	列表、获取、创建、更新、删除	contractproducts.md
ContractSchedule	contractschedules	列表、获取、创建、更新、删除	contractschedules.md
Country	countries	列表、获取	countries.md
Course	courses	列表、获取、创建、更新、删除	courses.md
CourseCompletedLesson	coursecompletedlessons	列表、获取、创建、更新、删除	coursecompletedlessons.md
CourseLesson	courselessons	列表、获取、创建、更新、删除	courselessons.md
CourseMember	coursemembers	列表、获取、创建、更新、删除	coursemembers.md
CourseSection	coursesections	列表、获取、创建、更新、删除	coursesections.md
Coworker	coworkers	列表、获取、创建、更新、命令	coworkers.md
CoworkerAccessControlAudit	coworkeraccesscontrolaudits	列表、获取、创建、更新、删除	coworkeraccesscontrolaudits.md
CoworkerBookingCredit	coworkerbookingcredits	列表、获取、创建、更新、删除	coworkerbookingcredits.md
CoworkerBookingCreditUseHistory	coworkerbookingcreditusehistories	列表、获取、创建、更新	coworkerbookingcreditusehistories.md
CoworkerContract	coworkercontracts	列表、获取、创建、更新、删除	coworkercontracts.md
CoworkerDataFile	coworkerdatafiles	列表、获取、创建、更新、删除	coworkerdatafiles.md
CoworkerDelivery	coworkerdeliveries	列表、获取、创建、更新、删除	coworkerdeliveries.md
CoworkerDiscountCode	coworkerdiscountcodes	列表、获取、创建、更新、删除	coworkerdiscountcodes.md
CoworkerExtraService	coworkerextraservices	列表、获取、创建、更新、删除	coworkerextraservices.md
CoworkerExtraServiceUseHistory	coworkerextraserviceusehistories	列表、获取、创建、更新、删除	coworkerextraserviceusehistories.md
CoworkerGoogleCalendar	coworkergooglecalendars	列表、获取、创建、更新、删除	coworkergooglecalendars.md
CoworkerIdentityCheck	coworkeridentitychecks	列表、获取、创建、更新、删除	coworkeridentitychecks.md
CoworkerIdentityCheckDocument	coworkeridentitycheckdocuments	列表、获取、创建、更新、删除	coworkeridentitycheckdocuments.md
CoworkerInventoryAsset	coworkerinventoryassets	列表、获取、创建、更新、删除	coworkerinventoryassets.md
CoworkerInvoice	coworkerinvoices	列表、获取、更新	coworkerinvoices.md
CoworkerInvoiceHistory	coworkerinvoicehistories	列表、获取、创建、更新、删除	coworkerinvoicehistories.md
CoworkerInvoiceLine	coworkerinvoicelines	列表、获取、更新	coworkerinvoicelines.md
CoworkerInvoicePaymentToken	coworkerinvoicepaymenttokens	列表、获取、创建、更新、删除	coworkerinvoicepaymenttokens.md
CoworkerLedgerEntry	coworkerledgerentries	列表、获取、创建、更新、删除	coworkerledgerentries.md
CoworkerLegalContentAudit	coworkerlegalcontentaudits	列表、获取、创建、更新、删除	coworkerlegalcontentaudits.md
CoworkerMessage	coworkermessages	列表、获取	coworkermessages.md
CoworkerMsOfficeCalendar	coworkermsofficecalendars	列表、获取、创建、更新、删除	coworkermsofficecalendars.md
CoworkerNote	coworkernotes	列表、获取、创建、更新、删除	coworkernotes.md
CoworkerNotification	coworkernotifications	列表、获取、创建、更新、删除	coworkernotifications.md
CoworkerPaymentMethod	coworkerpaymentmethods	列表、获取、创建、更新、删除	coworkerpaymentmethods.md
CoworkerPricePlanHistory	coworkerpriceplanhistories	列表、获取	coworkerpriceplanhistories.md
CoworkerProduct	coworkerproducts	列表、获取、创建、更新、删除	coworkerproducts.md
CoworkerReminderAudit	coworkerreminderaudits	列表、获取、创建、更新、删除	coworkerreminderaudits.md
CoworkerSetting	coworkersettings	列表、获取、创建、更新、删除	coworkersettings.md
CoworkerTask	coworkertasks	列表、获取、创建、更新、删除	coworkertasks.md
CoworkerTimePass	coworkertimepasses	列表、获取、创建、更新、删除	coworkertimepasses.md
CrmBoard	crmboards	列表、获取、创建、更新、删除	crmboards.md
CrmBoardColumn	crmboardcolumns	列表、获取、创建、更新、删除	crmboardcolumns.md
CrmOpportunity	crmopportunities	列表、获取、创建、更新、删除	crmopportunities.md
CrmOpportunityHistory	crmopportunityhistories	列表、获取、创建、更新、删除	crmopportunityhistories.md
CrmOpportunityImportFile	crmopportunityimportfiles	列表、获取、创建、更新、删除	crmopportunityimportfiles.md
Currency	currencies	列表、获取	currencies.md
CustomField	customfields	列表、获取、创建、更新、删除	customfields.md
DataFile	datafiles	列表、获取、创建、更新、删除	datafiles.md
DiscountCode	discountcodes	列表、获取、创建、更新、删除	discountcodes.md
DocumentTemplate	documenttemplates	列表、获取、创建、更新、删除	documenttemplates.md
EloxxLockersAudit	eloxxlockersaudits	列表、获取、创建、更新、删除	eloxxlockersaudits.md
EmailAccount	emailaccounts	列表、获取、创建、更新、删除	emailaccounts.md
EmailQueueItem	emailqueueitems	列表、获取	emailqueueitems.md
EmailQueueItemAttachment	emailqueueitemattachments	列表、获取、更新	emailqueueitemattachments.md
EmailTemplateFile	emailtemplatefiles	列表、获取、创建、更新、删除	emailtemplatefiles.md
EventAttendee	eventattendees	列表、获取、创建、更新、删除	eventattendees.md
EventComment	eventcomments	列表、获取、创建、更新、删除	eventcomments.md
EventProduct	eventproducts	列表、获取、创建、更新、删除	eventproducts.md
EventWaitingAttendee	eventwaitingattendees	列表、获取、创建、更新、删除	eventwaitingattendees.md
ExtraService	extraservices	列表、获取、创建、更新、删除	extraservices.md
ExtraServicePrice	extraserviceprices	列表、获取、创建、更新、删除	extraserviceprices.md
ExtraServiceTimeSlot	extraservicetimeslots	列表、获取、创建、更新、删除	extraservicetimeslots.md
FailedCheckin	failedcheckins	列表、获取、创建、更新、删除	failedcheckins.md
FaqArticle	faqarticles	列表、获取、创建、更新、删除	faqarticles.md
FinancialAccount	financialaccounts	列表、获取、创建、更新、删除	financialaccounts.md
FloorPlan	floorplans	列表、获取、创建、更新、删除	floorplans.md
FloorPlanAsset	floorplanassets	列表、获取	floorplanassets.md
FloorPlanDesk	floorplandesks	列表、获取、创建、更新、删除	floorplandesks.md
FloorPlanDeskVariant	floorplandeskvariants	列表、获取、创建、更新、删除	floorplandeskvariants.md
FloorPlanLayout	floorplanlayouts	列表、获取、创建、更新、删除	floorplanlayouts.md
FloorPlanLayoutArea	floorplanlayoutareas	列表、获取、创建、更新、删除	floorplanlayoutareas.md
FloorPlanLayoutAsset	floorplanlayoutassets	列表、获取、创建、更新、删除	floorplanlayoutassets.md
FloorPlanLayoutEdge	floorplanlayoutedges	列表、获取、创建、更新、删除	floorplanlayoutedges.md
FloorPlanLayoutNode	floorplanlayoutnodes	列表、获取、创建、更新、删除	floorplanlayoutnodes.md
FloorPlanLayoutOpening	floorplanlayoutopenings	列表、获取、创建、更新、删除	floorplanlayoutopenings.md
FloorplanLayoutTransition	floorplanlayouttransitions	列表、获取、创建、更新、删除	floorplanlayouttransitions.md
FormPage	formpages	列表、获取、创建、更新、删除	formpages.md
FormPageAnswer	formpageanswers	列表、获取、创建、更新	formpageanswers.md
FormPageQuestion	formpagequestions	列表、获取、创建、更新、删除	formpagequestions.md
FormPageRequest	formpagerequests	列表、获取、创建、更新、删除	formpagerequests.md
GlobalChatMessage	globalchatmessages	列表、获取、创建、更新、删除	globalchatmessages.md
HelpDeskComment	helpdeskcomments	列表、获取、创建、更新、删除	helpdeskcomments.md
HelpDeskDepartment	helpdeskdepartments	列表、获取、创建、更新、删除	helpdeskdepartments.md
HelpDeskMessage	helpdeskmessages	列表、获取、创建、更新、删除	helpdeskmessages.md
ImageFile	imagefiles	列表、获取、创建、更新、删除	imagefiles.md
InstalledApplication	installedapplications	列表、获取、创建、更新、删除	installedapplications.md
InstalledMarketPlaceApplication	installedmarketplaceapplications	列表、获取、创建、更新、删除	installedmarketplaceapplications.md
InventoryAsset	inventoryassets	列表、获取、创建、更新、删除	inventoryassets.md
Invoice	invoices	列表、获取、更新	invoices.md
Language	languages	列表、获取、创建、更新、删除	languages.md
LanguageToken	languagetokens	列表、获取、创建、更新、删除	languagetokens.md
LedgerEntry	ledgerentries	列表、获取	ledgerentries.md
LegalContentAudit	legalcontentaudits	列表、获取、创建、更新、删除	legalcontentaudits.md
LogEntry	logentries	列表、获取	logentries.md
MarketPlaceApplication	marketplaceapplications	列表、获取、创建、更新、删除	marketplaceapplications.md
MsOfficeAdminCalendar	msofficeadmincalendars	列表、获取、创建、更新、删除	msofficeadmincalendars.md
NewsLetter	newsletters	列表、获取、创建、更新、删除	newsletters.md
NewsLetterSubscriber	newslettersubscribers	列表、获取、创建、更新、删除	newslettersubscribers.md
OpenAiChatMessage	openaichatmessages	列表、获取、创建、更新、删除	openaichatmessages.md
OpportunityType	opportunitytypes	列表、获取、创建、更新、删除	opportunitytypes.md
PassportCard	passportcards	列表、获取、创建、更新、删除	passportcards.md
PaymentGateway	paymentgateways	列表、获取、创建、更新、删除	paymentgateways.md
PayoutInvoice	payoutinvoices	列表、获取、创建、更新、删除	payoutinvoices.md
PlatformChangeMessage	platformchangemessages	列表、获取、创建、更新、删除	platformchangemessages.md
ProactiveActionConfig	proactiveactionconfigs	列表、获取、创建、更新、删除	proactiveactionconfigs.md
Product	products	列表、获取、创建、更新、删除、命令	products.md
ProductBookingCredit	productbookingcredits	列表、获取、创建、更新、删除	productbookingcredits.md
ProductExtraService	productextraservices	列表、获取、创建、更新、删除	productextraservices.md
ProductTimePass	producttimepasses	列表、获取、创建、更新、删除	producttimepasses.md
Proposal	proposals	列表、获取、创建、更新、删除	proposals.md
ProposalContract	proposalcontracts	列表、获取、创建、更新、删除	proposalcontracts.md
ProposalContractSchedule	proposalcontractschedules	列表、获取、创建、更新、删除	proposalcontractschedules.md
ProposalProduct	proposalproducts	列表、获取、创建、更新、删除	proposalproducts.md
ProposalSchedule	proposalschedules	列表、获取、创建、更新、删除	proposalschedules.md
ProposedAction	proposedactions	列表、获取、创建、更新、删除	proposedactions.md
RadiusServer	radiusservers	列表、获取、创建、更新、删除	radiusservers.md
RecordCreationWorkflow	recordcreationworkflows	列表、获取、创建、更新、删除	recordcreationworkflows.md
RecordCreationWorkflowVersion	recordcreationworkflowversions	列表、获取、创建、更新、删除	recordcreationworkflowversions.md
RefreshToken	refreshtokens	列表、获取、创建、更新、删除	refreshtokens.md
RegisteredDevice	registereddevices	列表、获取、更新	registereddevices.md
Reminder	reminders	列表、获取、创建、更新、删除	reminders.md
Report	reports	列表、获取、创建、更新、删除	reports.md
ReportDashboard	reportdashboards	列表、获取、创建、更新、删除	reportdashboards.md
ReportDefinition	reportdefinitions	列表、获取、创建、更新、删除	reportdefinitions.md
ReportSubscription	reportsubscriptions	列表、获取、创建、更新、删除	reportsubscriptions.md
Reseller	resellers	列表、获取、创建、更新、删除	resellers.md
ResellerAccount	reselleraccounts	列表、获取、创建、更新、删除	reselleraccounts.md
ResellerPayout	resellerpayouts	列表、获取、创建、更新、删除	resellerpayouts.md
Resource	resources	列表、获取、创建、更新、删除	resources.md
ResourceAccessRule	resourceaccessrules	列表、获取、创建、更新、删除	resourceaccessrules.md
ResourceAccessRuleEligibleTimeSlot	resourceaccessruleeligibletimeslots	列表、获取、创建、更新、删除	resourceaccessruleeligibletimeslots.md
ResourceAccessRuleTimeSlot	resourceaccessruletimeslots	列表、获取、创建、更新、删除	resourceaccessruletimeslots.md
ResourceProduct	resourceproducts	列表、获取、创建、更新、删除	resourceproducts.md
ResourceTimeSlot	resourcetimeslots	列表、获取、创建、更新、删除	resourcetimeslots.md
ResourceType	resourcetypes	列表、获取、创建、更新、删除	resourcetypes.md
Role	roles	列表、获取	roles.md
Sensor	sensors	列表、获取、创建、更新、删除	sensors.md
SensorHistory	sensorhistories	列表、获取、创建、更新、删除	sensorhistories.md
SimpleTimeZone	simpletimezones	列表、获取、更新	simpletimezones.md
SubscriberActivity	subscriberactivities	列表、获取	subscriberactivities.md
SubscriberGroup	subscribergroups	列表、获取、创建、更新、删除	subscribergroups.md
Survey	surveys	列表、获取、创建、更新、删除	surveys.md
SurveyAnswer	surveyanswers	列表、获取、创建、更新、删除	surveyanswers.md
SurveyQuestion	surveyquestions	列表、获取、创建、更新、删除	surveyquestions.md
SurveyRun	surveyruns	列表、获取、创建、更新、删除	surveyruns.md
SystemNotification	systemnotifications	列表、获取、创建、更新、删除	systemnotifications.md
Tariff	tariffs	列表、获取、创建、更新、删除	tariffs.md
TariffBookingCredit	tariffbookingcredits	列表、获取、创建、更新、删除	tariffbookingcredits.md
TariffDefaultDueDate	tariffdefaultduedates	列表、获取、创建、更新、删除	tariffdefaultduedates.md
TariffExtraService	tariffextraservices	列表、获取、创建、更新、删除	tariffextraservices.md
TariffProduct	tariffproducts	列表、获取、创建、更新、删除	tariffproducts.md
TariffSignupProduct	tariffsignupproducts	列表、获取、创建、更新、删除	tariffsignupproducts.md
TariffTimePass	tarifftimepasses	列表、获取、创建、更新、删除	tarifftimepasses.md
TaskItem	taskitems	列表、获取、创建、更新、删除	taskitems.md
TaskList	tasklists	列表、获取、创建、更新、删除	tasklists.md
TaxRate	taxrates	列表、获取、创建、更新、删除	taxrates.md
Team	teams	列表、获取、创建、更新、删除	teams.md
TemplateFile	templatefiles	列表、获取、创建、更新、删除	templatefiles.md
TemplateVersion	templateversions	列表、获取、创建、更新、删除	templateversions.md
Ticket	tickets	列表、获取、创建、更新、删除	tickets.md
TimePass	timepasses	列表、获取、创建、更新、删除	timepasses.md
TimePassPrice	timepassprices	列表、获取、创建、更新、删除	timepassprices.md
TimePassTimeSlot	timepasstimeslots	列表、获取、创建、更新、删除	timepasstimeslots.md
UiModule	uimodules	列表、获取、创建、更新、删除	uimodules.md
User	users	列表、获取、创建、更新、删除	users.md
UserBookmark	userbookmarks	列表、获取、创建、更新、删除	userbookmarks.md
UserMessage	usermessages	列表、获取	usermessages.md
UserRole	userroles	列表、获取、创建、更新、删除	userroles.md
ValidationRule	validationrules	列表、获取、创建、更新、删除	validationrules.md
VideoFile	videofiles	列表、获取、创建、更新、删除	videofiles.md
VideoRoom	videorooms	列表、获取、创建、更新、删除	videorooms.md
Visitor	visitors	列表、获取、创建、更新、删除	visitors.md
WebHook	webhooks	列表、获取、创建、更新、删除	webhooks.md
Workspace	workspaces	列表、获取、创建、更新、删除	workspaces.md

图片上传

某些实体具有图片属性（logo、横幅、图片等）。要设置图片，必须提供两个属性：

1. New{PropertyName}Url —— Nexudus 后端可从中下载图片的公开访问 URL。本地文件路径或需要身份验证的 URL 均无法使用。
2. {PropertyName}FileName —— 用于保存图片的文件名（含扩展名）。只能使用非特殊字符（字母、数字、连字符、下划线），并且必须包含文件扩展名（例如，.png、.jpg）。

如果用户未提供文件名，请从 URL 中提取（使用最后一个路径段，并去除查询字符串和特殊字符），或生成一个合理的默认名称，例如 image.png。务必确保名称仅包含安全字符，并带有有效的图片扩展名。

实体	图片属性	CLI URL 选项	API URL 属性	CLI FileName 选项	API FileName 属性
Business	Logo	--logo-url	NewLogoUrl	--logo-file-name	LogoFileName
Business	BannerImage	--banner-url	NewBannerImageUrl	--banner-file-name	BannerImageFileName
Business	NexIoBannerImage	--nexio-banner-url	NewNexIoBannerImageUrl	--nexio-banner-file-name	NexIoBannerImageFileName
Business	PassportBanner	--passport-banner-url	NewPassportBannerUrl	--passport-banner-file-name	PassportBannerFileName
Resource	Picture	--new-picture-url	NewPictureUrl	--picture-file-name	PictureFileName

示例 —— 为一个 Business 设置 logo：

nexudus businesses update <id> --logo-url "https://example.com/logo.png" --logo-file-name "logo.png" --agent

示例 —— 为一个 Resource 设置图片：

nexudus resources update <id> --new-picture-url "https://example.com/room.jpg" --picture-file-name "room.jpg" --agent

示例 —— 用户只提供 URL（Agent 推导文件名）：

# User says: set the logo to https://cdn.example.com/images/my-logo.png
# Agent extracts "my-logo.png" from the URL path
nexudus businesses update <id> --logo-url "https://cdn.example.com/images/my-logo.png" --logo-file-name "my-logo.png" --agent

示例 —— URL 中没有可用的文件名（Agent 生成一个文件名）：

# User says: set the logo to https://cdn.example.com/generate?id=abc
# Agent cannot extract a file name, so it generates a safe default
nexudus businesses update <id> --logo-url "https://cdn.example.com/generate?id=abc" --logo-file-name "logo.png" --agent

Nexudus API 模式

Nexudus API 遵循一致的 REST 模式。/api/{module}/{entities} 中的每个实体都支持：

操作	HTTP	URL
搜索	GET	/api/{module}/{entities}?page=1&size=25
获取单个实体	GET	/api/{module}/{entities}/{id}
创建	POST	/api/{module}/{entities}
更新	PUT	/api/{module}/{entities}
删除	DELETE	/api/{module}/{entities}/{id}
命令	GET	/api/{module}/{entities}/commands
运行命令	POST	/api/{module}/{entities}/runCommand

传递多个值（列表选项）

某些选项接受 ID 列表（例如，--tariffs、--teams、--linked-resources、--resource-types）。要传递多个值，请为每个值重复使用该标志：

nexudus resources update <id> --tariffs 101 --tariffs 202 --tariffs 303 --agent

请勿使用逗号分隔值或方括号语法——每个值都需要单独的标志。

在 --{list}、--added-{list} 和 --removed-{list} 之间进行选择

每个列表属性都有三个变体。请根据用途选择合适的变体：

变体	使用场景	效果
--{list}	默认选择。 你知道完整的目标列表。	使用提供的值替换整个列表。
--added-{list}	你想向现有列表中追加一项或多项，同时不更改其余内容。	将提供的 ID 合并到现有列表中。
--removed-{list}	你想从现有列表中移除一项或多项，同时不更改其余内容。	从现有列表中移除提供的 ID。

绝大多数情况下，请使用 --{list}。 只有在需要精细地进行增量更改时，才需要使用添加／移除变体。例如，向已有多个费率且不能影响其他费率的资源中添加一项新费率。

示例——替换资源上的所有费率：

nexudus resources update <id> --tariffs 101 --tariffs 202 --agent

示例——添加一项费率，不更改现有费率：

nexudus resources update <id> --added-tariffs 303 --agent

示例——移除一项费率，不更改现有费率：

nexudus resources update <id> --removed-tariffs 101 --agent

提示

• 需要扫描大量记录时，使用 --page-size 100 获取更大的页面。
• 使用 --id <id> 按单个 ID 筛选；如需按多个 ID 筛选，可重复使用 --id <id1> --id <id2>。
• 使用 --unique-id <guid> 按 UniqueId（GUID）筛选；可重复指定多个值。
• 将筛选选项与分页结合使用，可高效搜索。
• run-command 接受以逗号分隔的 ID，以便批量操作：nexudus products run-command archive 123,456,789 --agent。
• 业务实体无法通过 API 创建或删除，只能列出、查看和更新。
• 在非交互模式下运行删除命令时，务必传入 --yes。