Nexudus CLI Agent Skill

nexudus

Agent Invariants

1. Always use

   --agent

   flag on every CLI call. This returns a structured JSON envelope optimised for machine consumption.
2. 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 }
   }

3. Check

   ok

   first. If

   ok

   is

   false

   , read

   summary

   for the error message and stop.
4. Never prompt the user for credentials interactively. If

   ok

   is

   false

   with an auth error, tell the user to run

   nexudus login

   manually.
5. Use

   --yes

   or

   -y

   on delete commands to skip interactive confirmation prompts.
6. Use

   --json

   when you need raw data for scripting. Use

   --agent

   when you want the envelope with summary.
7. 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.
8. 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.

Bootstrapping

nexudus doctor --agent

data.CredentialsStored

data.ApiStatus

Run

nexudus login

to authenticate with your Nexudus account.

CLI Introspection

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

--help

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

Command Reference

Authentication

nexudus login

nexudus logout

nexudus whoami

Configuration

nexudus config get <key>

nexudus config set <key> <value>

base-url

Businesses

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

Products

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

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

Diagnostics

nexudus doctor --agent

Global Flags

--agent

--json

--md

--base-url <url>

Output Envelope

--agent

--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).

Error envelope

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

Decision Trees

"Find and display a business"

1. nexudus businesses list --agent

   (or

   --query "name"

   if searching)
2. Parse

   data

   array, find the target business

3. nexudus businesses get <id> --agent

   for full details

"Create a <entity>"

1. First find the business ID:

   nexudus businesses list --agent

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

3. Check

   ok

   is

   true

   , read

   data.Id

   for the new entity ID

"Update a <entity> <property>"

1. nexudus <entity> get <id> --agent

   to verify the entity exists

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

3. Verify the update by checking the returned

   data

"Delete a <entity>"

1. nexudus <entity> get <id> --agent

   to confirm the entity exists

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

3. Check

   ok

   is

   true

"List <entity> for a specific business"

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

2. For pagination: add

   --page N --size M

"Run an entity command on <entity>"

1. nexudus <entity> commands --agent

   to discover available commands

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

3. Add parameters with

   -p Name=Value

   if the command requires them

"Check CLI health"

1. nexudus doctor --agent

2. Verify

   data.CredentialsStored

   is

   true

3. Verify

   data.ApiStatus

   is

   "OK"

"Add passes to a product"

1. Find the product:

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

   → note the

   Id

2. Find (or create) the time pass:

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

   → note the

   Id

3. 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

4. Check

   ok

   is

   true

   , read

   data.Id

   for the new link ID

"List passes included in a product"

1. nexudus producttimepasses list --agent

2. Filter results where

   ProductId

   matches the target product

"Update passes included in a product"

1. nexudus producttimepasses list --agent

   → find the link by

   ProductId

   and

   TimePassId

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

3. Verify the update by checking the returned

   data

"Remove a pass from a product"

1. nexudus producttimepasses list --agent

   → find the link by

   ProductId

   and

   TimePassId

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

3. Check

   ok

   is

   true

Error Handling

ok: false

nexudus login

ok: false

nexudus login

ok: false

ok: false

ok: false

Entity Models

Business (key fields)

Id

Name

Address

TownCity

State

PostalCode

CountryName

Phone

EmailContact

WebAddress

CurrencyCode

Tags

PassportPublished

VenueType

Products

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

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

Product (key fields)

Id

BusinessId

BusinessName

Name

Price

Description

Sku

Tags

Visible

CurrencyCode

DisplayOrder

OnlyForMembers

OnlyForContacts

TrackStock

CurrentStock

Archived

TimePasses

• 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.

nexudus timepasses list --agent

nexudus timepasses list --query "search" --agent

nexudus timepasses list --page 2 --size 10 --agent

nexudus timepasses get <id> --agent

nexudus timepasses create --business <value> --name <value> --agent

nexudus timepasses update <id> --name "New Name" --agent

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

TimePass create options

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

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

Id

BusinessId

BusinessName

Name

Price

MinutesIncluded

CurrencyCode

OnlyForContacts

OnlyForMembers

Archived

ProductTimePasses

nexudus producttimepasses list --agent

nexudus producttimepasses list --query "search" --agent

nexudus producttimepasses list --page 2 --size 10 --agent

nexudus producttimepasses get <id> --agent

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

nexudus producttimepasses update <id> --name "New Name" --agent

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

ProductTimePass create options

--product-id

--time-pass-id

--passes-included

--expire-time-in-months

--expire-time-in-weeks

--expiration-type

--expires-in

ProductTimePass update options

--passes-included

--expire-time-in-months

--expire-time-in-weeks

--expiration-type

--expires-in

ProductTimePass (key fields)

Id

ProductId

ProductName

TimePassId

TimePassName

PassesIncluded

Resources

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

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

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

get

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.

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

--name

ResourceType update options

--name

ResourceType (key fields)

Id

BusinessId

BusinessName

Name

Currencies

nexudus currencies list --agent

nexudus currencies list --query "search" --agent

nexudus currencies list --page 2 --size 10 --agent

nexudus currencies get <id> --agent

Countries

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

Currency (key fields)

Id

Name

Code

Format

Image Uploads

New{PropertyName}Url

{PropertyName}

New{PropertyName}Url

--logo-url

NewLogoUrl

--banner-url

NewBannerImageUrl

--nexio-banner-url

NewNexIoBannerImageUrl

--passport-banner-url

NewPassportBannerUrl

--new-picture-url

NewPictureUrl

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

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

Nexudus API Pattern

/api/{module}/{entities}

/api/{module}/{entities}?page=1&size=25

/api/{module}/{entities}/{id}

/api/{module}/{entities}

/api/{module}/{entities}

/api/{module}/{entities}/{id}

/api/{module}/{entities}/commands

/api/{module}/{entities}/runCommand

Passing Multiple Values (List Options)

--tariffs

--teams

--linked-resources

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.