nexudus

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Nexudus CLI Agent Skill

Nexudus CLI Agent 技能

You can manage Nexudus coworking spaces through the

nexudus

CLI tool. This skill teaches you how to authenticate, query data, and perform CRUD operations against the Nexudus platform API.

你可以通过

nexudus

CLI工具管理Nexudus联合办公空间。本技能将教你如何进行身份验证、查询数据，以及对Nexudus平台API执行CRUD操作。

Agent Invariants

Agent 固定规则

Always use
--agent
flag on every CLI call. This returns a structured JSON envelope optimised for machine consumption.

Parse the JSON envelope before acting on results. The envelope has this shape:

json

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

Check
ok
first. If
```
ok
```
is
```
false
```
, read
```
summary
```
for the error message and stop.
Never prompt the user for credentials interactively. If
```
ok
```
is
```
false
```
with an auth error, tell the user to run
```
nexudus login
```
manually.
Use
--yes
or
-y
on delete commands to skip interactive confirmation prompts.
Use
--json
when you need raw data for scripting. Use
```
--agent
```
when you want the envelope with summary.
List responses omit collection properties. The API only returns list/array fields (e.g.,
```
Tariffs
```
,
```
Teams
```
,
```
LinkedResources
```
) when fetching a single entity by ID (
```
get <id>
```
). List commands return a simplified projection without these fields. If you need to read or verify a collection property, always fetch the individual entity first.
Use the current user's defaults for business, currency, country, and timezone. Before creating or updating entities that require a business (location), currency, country, or timezone, run
```
nexudus whoami --agent
```
and use the defaults from the response:
- ```
DefaultBusinessId
```
  — use as
```
--business
```
  when creating entities scoped to a location.
- ```
DefaultCurrencyId
```
  — use as
```
--currency-id
```
  when a currency is needed.
- ```
DefaultCurrencyCode
```
  — for display/reference purposes.
- ```
DefaultCountryId
```
  — use as
```
--country-id
```
  when a country is needed.
- ```
DefaultSimpleTimeZoneId
```
  — use as
```
--timezone-id
```
  when a timezone is needed.
Only ask the user to specify these values if they explicitly want to override the defaults.

所有CLI调用必须使用
--agent
参数。该参数会返回一个针对机器处理优化的结构化JSON信封。

在处理结果前需解析JSON信封。信封结构如下：

json

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

首先检查
ok
字段。如果
```
ok
```
为
```
false
```
，请读取
```
summary
```
获取错误信息并停止操作。
切勿以交互方式提示用户输入凭据。如果因身份验证错误导致
```
ok
```
为
```
false
```
，请告知用户手动运行
```
nexudus login
```
。
删除命令需使用
--yes
或
-y
参数，以跳过交互确认提示。
编写脚本需要原始数据时使用
--json
参数。需要带摘要的信封时使用
```
--agent
```
参数。
列表响应会省略集合属性。仅当通过ID获取单个实体（
```
get <id>
```
）时，API才会返回列表/数组字段（如
```
Tariffs
```
、
```
Teams
```
、
```
LinkedResources
```
）。列表命令返回的是简化的投影结果，不包含这些字段。如果需要读取或验证集合属性，请始终先获取单个实体。
使用当前用户的业务、货币、国家和时区默认值。在创建或更新需要指定业务（地点）、货币、国家或时区的实体之前，运行
```
nexudus whoami --agent
```
并使用响应中的默认值：
- ```
DefaultBusinessId
```
  — 创建限定地点的实体时，用作
```
--business
```
  参数的值。
- ```
DefaultCurrencyId
```
  — 需要指定货币时，用作
```
--currency-id
```
  参数的值。
- ```
DefaultCurrencyCode
```
  — 用于显示/参考。
- ```
DefaultCountryId
```
  — 需要指定国家时，用作
```
--country-id
```
  参数的值。
- ```
DefaultSimpleTimeZoneId
```
  — 需要指定时区时，用作
```
--timezone-id
```
  参数的值。
仅当用户明确想要覆盖默认值时，才要求用户指定这些值。

Bootstrapping

初始化

Run diagnostics first to verify the CLI is ready:

shell

nexudus doctor --agent

This returns CLI version, .NET runtime, OS, credential status, config file location, API connectivity, and all available commands. Check

data.CredentialsStored

and

data.ApiStatus

before proceeding.

If credentials are missing, instruct the user:

Run
nexudus login
to authenticate with your Nexudus account.

先运行诊断命令验证CLI是否就绪：

shell

nexudus doctor --agent

该命令会返回CLI版本、.NET运行时、操作系统、凭据状态、配置文件位置、API连通性以及所有可用命令。在继续操作前，请检查

data.CredentialsStored

和

data.ApiStatus

。

如果缺少凭据，请指导用户：

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

CLI Introspection

CLI 自省

Discover available commands and options at any time:

shell

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

Each command also supports

--help

for detailed option information:

shell

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

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

shell

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

每个命令也支持

--help

参数以查看详细选项信息：

shell

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

Command Reference

命令参考

Authentication

身份验证

Command	Description
`nexudus login`	Authenticate (interactive prompt)
`nexudus logout`	Clear stored credentials
`nexudus whoami`	Show current authenticated user

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

Configuration

配置

Command	Description
`nexudus config get <key>`	Read a config value
`nexudus config set <key> <value>`	Set a config value

Config keys:

base-url

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

配置键：

base-url

Businesses

业务（Businesses）

Businesses support Search, Get, and Update (no Create or Delete via API).

Command	Description
`nexudus businesses list --agent`	List all businesses
`nexudus businesses list --query "London" --agent`	Search businesses by name
`nexudus businesses list --page 2 --size 10 --agent`	Paginated list
`nexudus businesses get <id> --agent`	Get single business
`nexudus businesses update <id> --name "New Name" --agent`	Update business fields

业务支持搜索、获取和更新操作（API不支持创建或删除）。

命令	描述
`nexudus businesses list --agent`	列出所有业务
`nexudus businesses list --query "London" --agent`	按名称搜索业务
`nexudus businesses list --page 2 --size 10 --agent`	分页列表
`nexudus businesses get <id> --agent`	获取单个业务详情
`nexudus businesses update <id> --name "New Name" --agent`	更新业务字段

Business update options

业务更新选项

--name

--short-intro

--about

--quote

--terms

--website

--web-contact

--privacy-url

--cookie-url

--address

--street-name

--street-number

--neighborhood

--city

--state

--postcode

--country-id

--longitude

--latitude

--phone

--fax

--email

--contact-phone

--contact-email

--currency-id

--timezone-id

--default-language

--venue-type

--tags

--floors

--floor-space

--floor-space-unit

--passport-published

--passport-name

--passport-tagline

--passport-description

--logo-url

--banner-url

--nexio-banner-url

--passport-banner-url

--name

--short-intro

--about

--quote

--terms

--website

--web-contact

--privacy-url

--cookie-url

--address

--street-name

--street-number

--neighborhood

--city

--state

--postcode

--country-id

--longitude

--latitude

--phone

--fax

--email

--contact-phone

--contact-email

--currency-id

--timezone-id

--default-language

--venue-type

--tags

--floors

--floor-space

--floor-space-unit

--passport-published

--passport-name

--passport-tagline

--passport-description

--logo-url

--banner-url

--nexio-banner-url

--passport-banner-url

Products

产品（Products）

Products support full CRUD plus entity commands.

Command	Description
`nexudus products list --agent`	List all products
`nexudus products list --query "Pass" --agent`	Search products by name
`nexudus products list --business <id> --agent`	Filter by business
`nexudus products list --page 2 --size 10 --agent`	Paginated list
`nexudus products get <id> --agent`	Get single product
`nexudus products create --name "Day Pass" --price 25.00 --business <id> --agent`	Create product
`nexudus products update <id> --name "New Name" --price 30.00 --agent`	Update product
`nexudus products delete <id> --yes --agent`	Delete product (no prompt)
`nexudus products commands --agent`	List available entity commands
`nexudus products run-command <key> <ids> --agent`	Run entity command

产品支持完整的CRUD操作及实体命令。

命令	描述
`nexudus products list --agent`	列出所有产品
`nexudus products list --query "Pass" --agent`	按名称搜索产品
`nexudus products list --business <id> --agent`	按业务筛选产品
`nexudus products list --page 2 --size 10 --agent`	分页列表
`nexudus products get <id> --agent`	获取单个产品详情
`nexudus products create --name "Day Pass" --price 25.00 --business <id> --agent`	创建产品
`nexudus products update <id> --name "New Name" --price 30.00 --agent`	更新产品
`nexudus products delete <id> --yes --agent`	删除产品（无提示）
`nexudus products commands --agent`	列出可用实体命令
`nexudus products run-command <key> <ids> --agent`	执行实体命令

Product create options

产品创建选项

--name

(required),

--business

(required),

--price

(required),

--description

--sku

--tags

--visible

--currency-id

--tax-rate-id

--display-order

--only-for-members

--only-for-contacts

--track-stock

--financial-account-id

--name

（必填）,

--business

（必填）,

--price

（必填）,

--description

--sku

--tags

--visible

--currency-id

--tax-rate-id

--display-order

--only-for-members

--only-for-contacts

--track-stock

--financial-account-id

Product update options

产品更新选项

--name

--price

--description

--sku

--tags

--visible

--currency-id

--tax-rate-id

--display-order

--only-for-members

--only-for-contacts

--track-stock

--archived

--financial-account-id

--name

--price

--description

--sku

--tags

--visible

--currency-id

--tax-rate-id

--display-order

--only-for-members

--only-for-contacts

--track-stock

--archived

--financial-account-id

Diagnostics

诊断

shell

nexudus doctor --agent

shell

nexudus doctor --agent

Global Flags

全局参数

Flag	Description
`--agent`	JSON envelope with summary (use this)
`--json`	Raw JSON envelope
`--md`	Markdown output
`--base-url <url>`	Override API base URL

参数	描述
`--agent`	带摘要的JSON信封（推荐使用）
`--json`	原始JSON信封
`--md`	Markdown格式输出
`--base-url <url>`	覆盖API基础URL

Output Envelope

输出信封

All commands produce a JSON envelope when

--agent

--json

is used:

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
```
on success,
```
false
```
on failure.
data
: The response payload — an object for single-entity operations, an array for lists, or null on some failures.
summary
: Human-readable result description.
breadcrumbs
: Command path that produced the output (e.g.,
```
["products", "create"]
```
).
meta
: Pagination metadata for list operations (present only on list commands).

当使用

--agent

或

--json

参数时，所有命令都会生成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
：列表操作的分页元数据（仅列表命令会返回）。

Error envelope

错误信封

json

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

json

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

Decision Trees

决策树

"Find and display a business"

"查找并显示某个业务"

nexudus businesses list --agent

(or

--query "name"

if searching)

Parse
```
data
```
array, find the target business
```
nexudus businesses get <id> --agent
```
for full details

运行

nexudus businesses list --agent

（如果是搜索则使用

--query "name"

）

解析
```
data
```
数组，找到目标业务
运行
```
nexudus businesses get <id> --agent
```
获取完整详情

"Create a <entity>"

"创建一个<实体>"

First find the business ID:
```
nexudus businesses list --agent
```

nexudus <entity> create --name "Day Pass" --price 25.00 --business <businessId> --agent

Check
```
ok
```
is
```
true
```
, read
```
data.Id
```
for the new entity ID

首先获取业务ID：
```
nexudus businesses list --agent
```

运行

nexudus <entity> create --name "Day Pass" --price 25.00 --business <businessId> --agent

检查
```
ok
```
是否为
```
true
```
，读取
```
data.Id
```
获取新实体的ID

"Update a <entity> <property>"

"更新<实体>的<属性>"

```
nexudus <entity> get <id> --agent
```
to verify the entity exists

nexudus <entity> update <id> --<property> <value> --agent

Verify the update by checking the returned
```
data
```

运行
```
nexudus <entity> get <id> --agent
```
验证实体存在

运行

nexudus <entity> update <id> --<property> <value> --agent

通过检查返回的
```
data
```
验证更新是否成功

"Delete a <entity>"

"删除一个<实体>"

```
nexudus <entity> get <id> --agent
```
to confirm the entity exists

nexudus <entity> delete <id> --yes --agent

Check
```
ok
```
is
```
true
```

运行
```
nexudus <entity> get <id> --agent
```
确认实体存在

运行

nexudus <entity> delete <id> --yes --agent

检查
```
ok
```
是否为
```
true
```

"List <entity> for a specific business"

"列出特定业务的<实体>"

nexudus <entity> list --business <businessId> --agent

For pagination: add
```
--page N --size M
```

运行

nexudus <entity> list --business <businessId> --agent

如需分页：添加
```
--page N --size M
```
参数

"Run an entity command on <entity>"

"对<实体>执行实体命令"

```
nexudus <entity> commands --agent
```
to discover available commands

nexudus <entity> run-command <commandKey> <id1,id2> --agent

Add parameters with
```
-p Name=Value
```
if the command requires them

运行
```
nexudus <entity> commands --agent
```
查看可用命令

运行

nexudus <entity> run-command <commandKey> <id1,id2> --agent

如果命令需要参数，使用
```
-p Name=Value
```
添加

"Check CLI health"

"检查CLI健康状态"

```
nexudus doctor --agent
```
Verify
```
data.CredentialsStored
```
is
```
true
```
Verify
```
data.ApiStatus
```
is
```
"OK"
```

运行
```
nexudus doctor --agent
```
验证
```
data.CredentialsStored
```
为
```
true
```
验证
```
data.ApiStatus
```
为
```
"OK"
```

"Add passes to a product"

"为产品添加通行证"

ProductTimePasses link a TimePass to a Product so that customers purchasing the product automatically receive those passes.

Find the product:

nexudus products list --query "Dat Pass Bundle" --agent

→ note the

Id

Find (or create) the time pass:

nexudus timepasses list --query "Day Pass" --agent

→ note the

Id

Create the link:

shell

nexudus producttimepasses create \
  --product-id <productId> \
  --time-pass-id <timePassId> \
  --passes-included 10 \
  --expire-time-in-months 1 \
  --expire-time-in-weeks 0 \
  --expires-in 30 \
  --agent

Check
```
ok
```
is
```
true
```
, read
```
data.Id
```
for the new link ID

ProductTimePasses用于将TimePass与产品关联，以便购买该产品的客户自动获得这些通行证。

查找产品：

nexudus products list --query "Dat Pass Bundle" --agent

→ 记录

Id

查找（或创建）TimePass：

nexudus timepasses list --query "Day Pass" --agent

→ 记录

Id

创建关联：

shell

nexudus producttimepasses create \
  --product-id <productId> \
  --time-pass-id <timePassId> \
  --passes-included 10 \
  --expire-time-in-months 1 \
  --expire-time-in-weeks 0 \
  --expires-in 30 \
  --agent

检查
```
ok
```
是否为
```
true
```
，读取
```
data.Id
```
获取新关联的ID

"List passes included in a product"

"列出产品包含的通行证"

```
nexudus producttimepasses list --agent
```
Filter results where
```
ProductId
```
matches the target product

运行
```
nexudus producttimepasses list --agent
```
筛选
```
ProductId
```
与目标产品匹配的结果

"Update passes included in a product"

"更新产品包含的通行证"

nexudus producttimepasses list --agent

→ find the link by

ProductId

and

TimePassId

nexudus producttimepasses update <id> --passes-included 20 --agent

Verify the update by checking the returned
```
data
```

运行

nexudus producttimepasses list --agent

→ 通过

ProductId

和

TimePassId

找到关联

运行

nexudus producttimepasses update <id> --passes-included 20 --agent

通过检查返回的
```
data
```
验证更新是否成功

"Remove a pass from a product"

"从产品中移除通行证"

nexudus producttimepasses list --agent

→ find the link by

ProductId

and

TimePassId

nexudus producttimepasses delete <id> --yes --agent

Check
```
ok
```
is
```
true
```

运行

nexudus producttimepasses list --agent

→ 通过

ProductId

和

TimePassId

找到关联

运行

nexudus producttimepasses delete <id> --yes --agent

检查
```
ok
```
是否为
```
true
```

Error Handling

错误处理

Error	Meaning	Action
`ok: false` , summary contains "Not logged in"	No stored credentials	Tell user to run `nexudus login`
`ok: false` , summary contains "Unauthorized"	Invalid credentials	Tell user to run `nexudus login` again
`ok: false` , summary contains "Forbidden"	Insufficient permissions	Inform user they lack API permissions
`ok: false` , summary contains "not found"	Entity doesn't exist	Check the ID and try again
`ok: false` , summary contains "Failed to create"	Create validation error	Check required fields (name, business, price)
Non-zero exit code	Command failed	Read stderr or the JSON envelope for details

错误	含义	操作
`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信封获取详细信息

Entity Models

实体模型

Business (key fields)

业务（关键字段）

Id

Name

Address

TownCity

State

PostalCode

CountryName

Phone

EmailContact

WebAddress

CurrencyCode

Tags

PassportPublished

VenueType

Id

Name

Address

TownCity

State

PostalCode

CountryName

Phone

EmailContact

WebAddress

CurrencyCode

Tags

PassportPublished

VenueType

Products

产品

Products support Search, Get, Create, Update, Delete. Products also support entity commands.

Command	Description
`nexudus products list --agent`	List all products
`nexudus products list --query "search" --agent`	Search products by name
`nexudus products list --page 2 --size 10 --agent`	Paginated list
`nexudus products get <id> --agent`	Get single product
`nexudus products create --business <value> --name <value> --price <value> --description <value> --agent`	Create product
`nexudus products update <id> --name "New Name" --agent`	Update product
`nexudus products delete <id> --yes --agent`	Delete product (no prompt)
`nexudus products commands --agent`	List available entity commands
`nexudus products run-command <key> <ids> --agent`	Run entity command

产品支持搜索、获取、创建、更新、删除操作。产品还支持实体命令。

命令	描述
`nexudus products list --agent`	列出所有产品
`nexudus products list --query "search" --agent`	按名称搜索产品
`nexudus products list --page 2 --size 10 --agent`	分页列表
`nexudus products get <id> --agent`	获取单个产品详情
`nexudus products create --business <value> --name <value> --price <value> --description <value> --agent`	创建产品
`nexudus products update <id> --name "New Name" --agent`	更新产品
`nexudus products delete <id> --yes --agent`	删除产品（无提示）
`nexudus products commands --agent`	列出可用实体命令
`nexudus products run-command <key> <ids> --agent`	执行实体命令

Product create options

产品创建选项

--business

(required),

--name

(required),

--price

(required),

--description

(required),

--sku

--tags

--visible

--currency-id

--tax-rate-id

--display-order

--only-for-members

--only-for-contacts

--track-stock

--archived

--financial-account-id

--business

（必填）,

--name

（必填）,

--price

（必填）,

--description

（必填）,

--sku

--tags

--visible

--currency-id

--tax-rate-id

--display-order

--only-for-members

--only-for-contacts

--track-stock

--archived

--financial-account-id

Product update options

产品更新选项

--name

--price

--description

--sku

--tags

--visible

--currency-id

--tax-rate-id

--display-order

--only-for-members

--only-for-contacts

--track-stock

--archived

--financial-account-id

--name

--price

--description

--sku

--tags

--visible

--currency-id

--tax-rate-id

--display-order

--only-for-members

--only-for-contacts

--track-stock

--archived

--financial-account-id

Product (key fields)

产品（关键字段）

Id

BusinessId

BusinessName

Name

Price

Description

Sku

Tags

Visible

CurrencyCode

DisplayOrder

OnlyForMembers

OnlyForContacts

TrackStock

CurrentStock

Archived

Id

BusinessId

BusinessName

Name

Price

Description

Sku

Tags

Visible

CurrencyCode

DisplayOrder

OnlyForMembers

OnlyForContacts

TrackStock

CurrentStock

Archived

TimePasses

Passes allow customers to check in to a coworking space. There are two kinds:

Day Pass — valid for a single calendar day. Created with
```
--minutes-included
```
omitted (null). The customer can check in any number of times during that day.
Time Pass — valid across multiple days up to a fixed amount of time. Created with
```
--minutes-included <minutes>
```
set. The customer can check in until the included minutes are exhausted.

TimePasses support Search, Get, Create, Update, Delete.

Command	Description
`nexudus timepasses list --agent`	List all timepasses
`nexudus timepasses list --query "search" --agent`	Search timepasses by name
`nexudus timepasses list --page 2 --size 10 --agent`	Paginated list
`nexudus timepasses get <id> --agent`	Get single timepass
`nexudus timepasses create --business <value> --name <value> --agent`	Create timepass
`nexudus timepasses update <id> --name "New Name" --agent`	Update timepass
`nexudus timepasses delete <id> --yes --agent`	Delete timepass (no prompt)

通行证允许客户签到联合办公空间。分为两种类型：

日通行证（Day Pass） — 单个日历日有效。创建时省略
```
--minutes-included
```
参数（设为null）。客户可在当日多次签到。
时长通行证（Time Pass） — 多日内有效，总时长固定。创建时设置
```
--minutes-included <minutes>
```
参数。客户可签到直到包含的时长用完。

TimePasses支持搜索、获取、创建、更新、删除操作。

命令	描述
`nexudus timepasses list --agent`	列出所有TimePass
`nexudus timepasses list --query "search" --agent`	按名称搜索TimePass
`nexudus timepasses list --page 2 --size 10 --agent`	分页列表
`nexudus timepasses get <id> --agent`	获取单个TimePass详情
`nexudus timepasses create --business <value> --name <value> --agent`	创建TimePass
`nexudus timepasses update <id> --name "New Name" --agent`	更新TimePass
`nexudus timepasses delete <id> --yes --agent`	删除TimePass（无提示）

TimePass create options

TimePass创建选项

--business

(required),

--name

(required),

--invoice-display

--price

--minutes-included

--counts-towards-plan

--payg-members

--payg-contacts

--use-priority

--currency-id

--tax-rate-id

--reduced-tax-rate-id

--exempt-tax-rate-id

--financial-account-id

--kisi-group-id

--door-guard-group-id

--allow-network-checkin

--only-for-contacts

--only-for-members

--archived

--business

（必填）,

--name

（必填）,

--invoice-display

--price

--minutes-included

--counts-towards-plan

--payg-members

--payg-contacts

--use-priority

--currency-id

--tax-rate-id

--reduced-tax-rate-id

--exempt-tax-rate-id

--financial-account-id

--kisi-group-id

--door-guard-group-id

--allow-network-checkin

--only-for-contacts

--only-for-members

--archived

TimePass update options

TimePass更新选项

--name

--invoice-display

--price

--minutes-included

--counts-towards-plan

--payg-members

--payg-contacts

--use-priority

--currency-id

--tax-rate-id

--reduced-tax-rate-id

--exempt-tax-rate-id

--financial-account-id

--kisi-group-id

--door-guard-group-id

--allow-network-checkin

--only-for-contacts

--only-for-members

--archived

--name

--invoice-display

--price

--minutes-included

--counts-towards-plan

--payg-members

--payg-contacts

--use-priority

--currency-id

--tax-rate-id

--reduced-tax-rate-id

--exempt-tax-rate-id

--financial-account-id

--kisi-group-id

--door-guard-group-id

--allow-network-checkin

--only-for-contacts

--only-for-members

--archived

TimePass (key fields)

TimePass（关键字段）

Id

BusinessId

BusinessName

Name

Price

MinutesIncluded

CurrencyCode

OnlyForContacts

OnlyForMembers

Archived

Id

BusinessId

BusinessName

Name

Price

MinutesIncluded

CurrencyCode

OnlyForContacts

OnlyForMembers

Archived

ProductTimePasses

ProductTimePasses support Search, Get, Create, Update, Delete.

Command	Description
`nexudus producttimepasses list --agent`	List all producttimepasses
`nexudus producttimepasses list --query "search" --agent`	Search producttimepasses by name
`nexudus producttimepasses list --page 2 --size 10 --agent`	Paginated list
`nexudus producttimepasses get <id> --agent`	Get single producttimepass
`nexudus producttimepasses create --product-id <value> --time-pass-id <value> --passes-included <value> --expire-time-in-months <value> --expire-time-in-weeks <value> --expires-in <value> --agent`	Create producttimepass
`nexudus producttimepasses update <id> --name "New Name" --agent`	Update producttimepass
`nexudus producttimepasses delete <id> --yes --agent`	Delete producttimepass (no prompt)

ProductTimePasses支持搜索、获取、创建、更新、删除操作。

命令	描述
`nexudus producttimepasses list --agent`	列出所有ProductTimePasses
`nexudus producttimepasses list --query "search" --agent`	按名称搜索ProductTimePasses
`nexudus producttimepasses list --page 2 --size 10 --agent`	分页列表
`nexudus producttimepasses get <id> --agent`	获取单个ProductTimePass详情
`nexudus producttimepasses create --product-id <value> --time-pass-id <value> --passes-included <value> --expire-time-in-months <value> --expire-time-in-weeks <value> --expires-in <value> --agent`	创建ProductTimePass
`nexudus producttimepasses update <id> --name "New Name" --agent`	更新ProductTimePass
`nexudus producttimepasses delete <id> --yes --agent`	删除ProductTimePass（无提示）

ProductTimePass create options

ProductTimePass创建选项

--product-id

(required),

--time-pass-id

(required),

--passes-included

(required),

--expire-time-in-months

(required),

--expire-time-in-weeks

(required),

--expiration-type

--expires-in

(required)

--product-id

（必填）,

--time-pass-id

（必填）,

--passes-included

（必填）,

--expire-time-in-months

（必填）,

--expire-time-in-weeks

（必填）,

--expiration-type

--expires-in

（必填）

ProductTimePass update options

ProductTimePass更新选项

--passes-included

--expire-time-in-months

--expire-time-in-weeks

--expiration-type

--expires-in

--passes-included

--expire-time-in-months

--expire-time-in-weeks

--expiration-type

--expires-in

ProductTimePass (key fields)

ProductTimePass（关键字段）

Id

ProductId

ProductName

TimePassId

TimePassName

PassesIncluded

Id

ProductId

ProductName

TimePassId

TimePassName

PassesIncluded

Resources

资源（Resources）

Resources support Search, Get, Create, Update, Delete.

Command	Description
`nexudus resources list --agent`	List all resources
`nexudus resources list --query "search" --agent`	Search resources by name
`nexudus resources list --page 2 --size 10 --agent`	Paginated list
`nexudus resources get <id> --agent`	Get single resource
`nexudus resources create --business <value> --name <value> --resource-type-id <value> --agent`	Create resource
`nexudus resources update <id> --name "New Name" --agent`	Update resource
`nexudus resources delete <id> --yes --agent`	Delete resource (no prompt)

资源支持搜索、获取、创建、更新、删除操作。

命令	描述
`nexudus resources list --agent`	列出所有资源
`nexudus resources list --query "search" --agent`	按名称搜索资源
`nexudus resources list --page 2 --size 10 --agent`	分页列表
`nexudus resources get <id> --agent`	获取单个资源详情
`nexudus resources create --business <value> --name <value> --resource-type-id <value> --agent`	创建资源
`nexudus resources update <id> --name "New Name" --agent`	更新资源
`nexudus resources delete <id> --yes --agent`	删除资源（无提示）

Resource create options

资源创建选项

--business

(required),

--name

(required),

--system-resource-type

--resource-type-id

(required),

--description

--email-confirmation-content

--visible

--requires-confirmation

--display-order

--group-name

--projector

--internet

--conference-phone

--standard-phone

--white-board

--large-display

--catering

--tea-and-coffee

--drinks

--security-lock

--cctv

--voice-recorder

--air-conditioning

--heating

--natural-light

--standing-desk

--quiet-zone

--wireless-charger

--privacy-screen

--soundproof

--video-conferencing

--dual-display-screen

--display-screen

--wireless-presentation

--pa-system

--desktop-monitor

--flip-chart

--secure-storage

--allow-multiple-bookings

--allocation

--limit-visitors-to-allocation

--book-in-advance-limit

--late-booking-limit

--late-cancellation-limit

--interval-limit

--no-return-policy

--no-return-policy-all-resources

--no-return-policy-all-users

--max-booking-length

--min-booking-length

--tariffs

(list, repeat flag),

--added-tariffs

(list, repeat flag),

--removed-tariffs

(list, repeat flag),

--teams

(list, repeat flag),

--added-teams

(list, repeat flag),

--removed-teams

(list, repeat flag),

--shifts

--linked-resources

(list, repeat flag),

--added-linked-resources

(list, repeat flag),

--removed-linked-resources

(list, repeat flag),

--longitude

--latitude

--hide-in-calendar

--archived

--use-shared-zoom-account

--zoom-user-id

--last-cleaned-at

--linked-resource-ids

--only-for-contacts

--only-for-members

--only-for-invoicing-business

--booking-availability-exceptions

(list, repeat flag),

--added-booking-availability-exceptions

(list, repeat flag),

--removed-booking-availability-exceptions

(list, repeat flag),

--cancellation-fee-product-id

--charge-cancellation-fee

--cancellation-fee-type

--cancellation-fee-amount

--cancellation-fee-percentage

--repeat-booking-quantity-limit

--repeat-booking-period-limit-in-months

--new-picture-url

--picture-file-name

--clear-picture-file

--business

（必填）,

--name

（必填）,

--system-resource-type

--resource-type-id

（必填）,

--description

--email-confirmation-content

--visible

--requires-confirmation

--display-order

--group-name

--projector

--internet

--conference-phone

--standard-phone

--white-board

--large-display

--catering

--tea-and-coffee

--drinks

--security-lock

--cctv

--voice-recorder

--air-conditioning

--heating

--natural-light

--standing-desk

--quiet-zone

--wireless-charger

--privacy-screen

--soundproof

--video-conferencing

--dual-display-screen

--display-screen

--wireless-presentation

--pa-system

--desktop-monitor

--flip-chart

--secure-storage

--allow-multiple-bookings

--allocation

--limit-visitors-to-allocation

--book-in-advance-limit

--late-booking-limit

--late-cancellation-limit

--interval-limit

--no-return-policy

--no-return-policy-all-resources

--no-return-policy-all-users

--max-booking-length

--min-booking-length

--tariffs

（列表，重复参数）,

--added-tariffs

（列表，重复参数）,

--removed-tariffs

（列表，重复参数）,

--teams

（列表，重复参数）,

--added-teams

（列表，重复参数）,

--removed-teams

（列表，重复参数）,

--shifts

--linked-resources

（列表，重复参数）,

--added-linked-resources

（列表，重复参数）,

--removed-linked-resources

（列表，重复参数）,

--longitude

--latitude

--hide-in-calendar

--archived

--use-shared-zoom-account

--zoom-user-id

--last-cleaned-at

--linked-resource-ids

--only-for-contacts

--only-for-members

--only-for-invoicing-business

--booking-availability-exceptions

（列表，重复参数）,

--added-booking-availability-exceptions

（列表，重复参数）,

--removed-booking-availability-exceptions

（列表，重复参数）,

--cancellation-fee-product-id

--charge-cancellation-fee

--cancellation-fee-type

--cancellation-fee-amount

--cancellation-fee-percentage

--repeat-booking-quantity-limit

--repeat-booking-period-limit-in-months

--new-picture-url

--picture-file-name

--clear-picture-file

Resource update options

资源更新选项

--name

--system-resource-type

--resource-type-id

--description

--email-confirmation-content

--visible

--requires-confirmation

--display-order

--group-name

--projector

--internet

--conference-phone

--standard-phone

--white-board

--large-display

--catering

--tea-and-coffee

--drinks

--security-lock

--cctv

--voice-recorder

--air-conditioning

--heating

--natural-light

--standing-desk

--quiet-zone

--wireless-charger

--privacy-screen

--soundproof

--video-conferencing

--dual-display-screen

--display-screen

--wireless-presentation

--pa-system

--desktop-monitor

--flip-chart

--secure-storage

--allow-multiple-bookings

--allocation

--limit-visitors-to-allocation

--book-in-advance-limit

--late-booking-limit

--late-cancellation-limit

--interval-limit

--no-return-policy

--no-return-policy-all-resources

--no-return-policy-all-users

--max-booking-length

--min-booking-length

--tariffs

(list, repeat flag),

--added-tariffs

(list, repeat flag),

--removed-tariffs

(list, repeat flag),

--teams

(list, repeat flag),

--added-teams

(list, repeat flag),

--removed-teams

(list, repeat flag),

--shifts

--linked-resources

(list, repeat flag),

--added-linked-resources

(list, repeat flag),

--removed-linked-resources

(list, repeat flag),

--longitude

--latitude

--hide-in-calendar

--archived

--use-shared-zoom-account

--zoom-user-id

--last-cleaned-at

--linked-resource-ids

--only-for-contacts

--only-for-members

--only-for-invoicing-business

--booking-availability-exceptions

(list, repeat flag),

--added-booking-availability-exceptions

(list, repeat flag),

--removed-booking-availability-exceptions

(list, repeat flag),

--cancellation-fee-product-id

--charge-cancellation-fee

--cancellation-fee-type

--cancellation-fee-amount

--cancellation-fee-percentage

--repeat-booking-quantity-limit

--repeat-booking-period-limit-in-months

--new-picture-url

--picture-file-name

--clear-picture-file

--name

--system-resource-type

--resource-type-id

--description

--email-confirmation-content

--visible

--requires-confirmation

--display-order

--group-name

--projector

--internet

--conference-phone

--standard-phone

--white-board

--large-display

--catering

--tea-and-coffee

--drinks

--security-lock

--cctv

--voice-recorder

--air-conditioning

--heating

--natural-light

--standing-desk

--quiet-zone

--wireless-charger

--privacy-screen

--soundproof

--video-conferencing

--dual-display-screen

--display-screen

--wireless-presentation

--pa-system

--desktop-monitor

--flip-chart

--secure-storage

--allow-multiple-bookings

--allocation

--limit-visitors-to-allocation

--book-in-advance-limit

--late-booking-limit

--late-cancellation-limit

--interval-limit

--no-return-policy

--no-return-policy-all-resources

--no-return-policy-all-users

--max-booking-length

--min-booking-length

--tariffs

（列表，重复参数）,

--added-tariffs

（列表，重复参数）,

--removed-tariffs

（列表，重复参数）,

--teams

（列表，重复参数）,

--added-teams

（列表，重复参数）,

--removed-teams

（列表，重复参数）,

--shifts

--linked-resources

（列表，重复参数）,

--added-linked-resources

（列表，重复参数）,

--removed-linked-resources

（列表，重复参数）,

--longitude

--latitude

--hide-in-calendar

--archived

--use-shared-zoom-account

--zoom-user-id

--last-cleaned-at

--linked-resource-ids

--only-for-contacts

--only-for-members

--only-for-invoicing-business

--booking-availability-exceptions

（列表，重复参数）,

--added-booking-availability-exceptions

（列表，重复参数）,

--removed-booking-availability-exceptions

（列表，重复参数）,

--cancellation-fee-product-id

--charge-cancellation-fee

--cancellation-fee-type

--cancellation-fee-amount

--cancellation-fee-percentage

--repeat-booking-quantity-limit

--repeat-booking-period-limit-in-months

--new-picture-url

--picture-file-name

--clear-picture-file

Resource (key fields)

资源（关键字段）

Id

BusinessId

BusinessName

Name

ResourceTypeId

ResourceTypeName

Visible

GroupName

Allocation

Archived

OnlyForContacts

OnlyForMembers

List properties (only returned by
get
, not by
list
):

Tariffs

AddedTariffs

RemovedTariffs

Teams

AddedTeams

RemovedTeams

LinkedResources

AddedLinkedResources

RemovedLinkedResources

BookingAvailabilityExceptions

AddedBookingAvailabilityExceptions

RemovedBookingAvailabilityExceptions

Resource Type (
ExtraService
): Every resource requires a
ResourceTypeId
that references an
ExtraService
entity. The resource type defines the hourly/daily rates and billing rules for bookings. You cannot create a resource without first knowing the ID of an existing resource type.

Id

BusinessId

BusinessName

Name

ResourceTypeId

ResourceTypeName

Visible

GroupName

Allocation

Archived

OnlyForContacts

OnlyForMembers

列表属性（仅
get
命令返回，
list
命令不返回）：

Tariffs

AddedTariffs

RemovedTariffs

Teams

AddedTeams

RemovedTeams

LinkedResources

AddedLinkedResources

RemovedLinkedResources

BookingAvailabilityExceptions

AddedBookingAvailabilityExceptions

RemovedBookingAvailabilityExceptions

资源类型（
ExtraService
）：每个资源都需要一个
ResourceTypeId
，引用
ExtraService
实体。资源类型定义了预订的时/日费率和计费规则。如果不知道现有资源类型的ID，无法创建资源。

ResourceTypes

资源类型（ResourceTypes）

ResourceTypes support Search, Get, Create, Update, Delete.

Command	Description
`nexudus resourcetypes list --agent`	List all resourcetypes
`nexudus resourcetypes list --query "search" --agent`	Search resourcetypes by name
`nexudus resourcetypes list --page 2 --size 10 --agent`	Paginated list
`nexudus resourcetypes get <id> --agent`	Get single resourcetype
`nexudus resourcetypes create --business <value> --agent`	Create resourcetype
`nexudus resourcetypes update <id> --name "New Name" --agent`	Update resourcetype
`nexudus resourcetypes delete <id> --yes --agent`	Delete resourcetype (no prompt)

ResourceTypes支持搜索、获取、创建、更新、删除操作。

命令	描述
`nexudus resourcetypes list --agent`	列出所有资源类型
`nexudus resourcetypes list --query "search" --agent`	按名称搜索资源类型
`nexudus resourcetypes list --page 2 --size 10 --agent`	分页列表
`nexudus resourcetypes get <id> --agent`	获取单个资源类型详情
`nexudus resourcetypes create --business <value> --agent`	创建资源类型
`nexudus resourcetypes update <id> --name "New Name" --agent`	更新资源类型
`nexudus resourcetypes delete <id> --yes --agent`	删除资源类型（无提示）

ResourceType create options

资源类型创建选项

--business

(required),

--name

--business

（必填）,

--name

ResourceType update options

资源类型更新选项

--name

--name

ResourceType (key fields)

资源类型（关键字段）

Id

BusinessId

BusinessName

Name

Id

BusinessId

BusinessName

Name

Currencies

货币（Currencies）

Currencies support Search, Get (no Create or Delete via API).

Command	Description
`nexudus currencies list --agent`	List all currencies
`nexudus currencies list --query "search" --agent`	Search currencies by name
`nexudus currencies list --page 2 --size 10 --agent`	Paginated list
`nexudus currencies get <id> --agent`	Get single currency

货币支持搜索、获取操作（API不支持创建或删除）。

命令	描述
`nexudus currencies list --agent`	列出所有货币
`nexudus currencies list --query "search" --agent`	按名称搜索货币
`nexudus currencies list --page 2 --size 10 --agent`	分页列表
`nexudus currencies get <id> --agent`	获取单个货币详情

Countries

国家（Countries）

Countries support Search, Get (no Create or Delete via API).

Command	Description
`nexudus countries list --agent`	List all countries
`nexudus countries list --query "search" --agent`	Search countries by name
`nexudus countries list --page 2 --size 10 --agent`	Paginated list
`nexudus countries get <id> --agent`	Get single country

国家支持搜索、获取操作（API不支持创建或删除）。

命令	描述
`nexudus countries list --agent`	列出所有国家
`nexudus countries list --query "search" --agent`	按名称搜索国家
`nexudus countries list --page 2 --size 10 --agent`	分页列表
`nexudus countries get <id> --agent`	获取单个国家详情

Country (key fields)

国家（关键字段）

Id

Name

TwoDigitsCode

Culture

Id

Name

TwoDigitsCode

Culture

Currency (key fields)

货币（关键字段）

Id

Name

Code

Format

Id

Name

Code

Format

Image Uploads

图片上传

Some entities have image properties (logo, banner, picture, etc.). To set an image, use the corresponding

New{PropertyName}Url

property, which accepts a publicly accessible URL. The Nexudus back-end downloads the image from that URL and stores it, so the URL must be reachable from the internet — local file paths or authenticated URLs will not work.

The naming convention is: for an image property called

{PropertyName}

, the upload property is

New{PropertyName}Url

Entity	Image Property	CLI Option	API Property
Business	Logo	`--logo-url`	`NewLogoUrl`
Business	BannerImage	`--banner-url`	`NewBannerImageUrl`
Business	NexIoBannerImage	`--nexio-banner-url`	`NewNexIoBannerImageUrl`
Business	PassportBanner	`--passport-banner-url`	`NewPassportBannerUrl`
Resource	Picture	`--new-picture-url`	`NewPictureUrl`

Example — set a logo on a business:

shell

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

Example — set a picture on a resource:

shell

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

部分实体包含图片属性（logo、banner、picture等）。要设置图片，请使用对应的

New{PropertyName}Url

属性，该属性接受公开可访问的URL。Nexudus后端会从该URL下载图片并存储，因此URL必须能从互联网访问——本地文件路径或需要认证的URL无法使用。

命名规则：对于名为

{PropertyName}

的图片属性，上传属性为

New{PropertyName}Url

。

实体	图片属性	CLI选项	API属性
业务	Logo	`--logo-url`	`NewLogoUrl`
业务	BannerImage	`--banner-url`	`NewBannerImageUrl`
业务	NexIoBannerImage	`--nexio-banner-url`	`NewNexIoBannerImageUrl`
业务	PassportBanner	`--passport-banner-url`	`NewPassportBannerUrl`
资源	Picture	`--new-picture-url`	`NewPictureUrl`

示例——为业务设置logo：

shell

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

示例——为资源设置图片：

shell

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

Nexudus API Pattern

Nexudus API 模式

The Nexudus API follows a consistent REST pattern. Each entity at

/api/{module}/{entities}

supports:

Operation	HTTP	URL
Search	GET	`/api/{module}/{entities}?page=1&size=25`
Get one	GET	`/api/{module}/{entities}/{id}`
Create	POST	`/api/{module}/{entities}`
Update	PUT	`/api/{module}/{entities}`
Delete	DELETE	`/api/{module}/{entities}/{id}`
Commands	GET	`/api/{module}/{entities}/commands`
Run command	POST	`/api/{module}/{entities}/runCommand`

Current entity mappings:

Entity	Module	Path
Business	sys	businesses
Product	billing	products
TimePass	billing	timepasses
ProductTimePass	billing	producttimepasses
Resource	spaces	resources
ResourceType	spaces	resourcetypes
Currency	sys	currencies
Country	sys	countries

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`

当前实体映射：

实体	模块	路径
Business	sys	businesses
Product	billing	products
TimePass	billing	timepasses
ProductTimePass	billing	producttimepasses
Resource	spaces	resources
ResourceType	spaces	resourcetypes
Currency	sys	currencies
Country	sys	countries

Passing Multiple Values (List Options)

传递多个值（列表选项）

Some options accept a list of IDs (e.g.,

--tariffs

--teams

--linked-resources

). To pass multiple values, repeat the flag for each value:

shell

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

Do not use comma-separated values or bracket syntax — each value needs its own flag.

部分选项接受ID列表（如

--tariffs

、

--teams

、

--linked-resources

）。要传递多个值，请为每个值重复参数：

shell

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

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

Tips

提示

Use
```
--size 100
```
to fetch larger pages when you need to scan many records.
Combine
```
--query
```
with pagination for efficient searching.

The

run-command

accepts comma-separated IDs to batch operations:

nexudus products run-command archive 123,456,789 --agent

Business entities cannot be created or deleted via the API — only listed, viewed, and updated.
Always pass
```
--yes
```
with delete commands whegin running non-interactively.

当需要扫描大量记录时，使用
```
--size 100
```
获取更大的分页结果。
结合
```
--query
```
和分页实现高效搜索。

run-command

接受逗号分隔的ID以批量操作：

nexudus products run-command archive 123,456,789 --agent

。

业务实体无法通过API创建或删除——仅支持列出、查看和更新。
非交互式运行时，删除命令务必加上
```
--yes
```
参数。