CLI Commands
The Nexudus CLI follows a consistent nexudus <entity> <action> pattern. Every entity supports a standard set of operations where applicable.
Command tree
nexudus
├── login # Authenticate and store credentials
├── logout # Clear stored credentials
├── whoami # Show current user info and defaults
├── doctor # Run environment diagnostics
├── config
│ ├── get <key> # Read a configuration value
│ └── set <key> <value> # Set a configuration value
├── businesses
│ ├── list [--query] [--page] # Search businesses
│ ├── get <id> # Get a single business
│ └── update <id> [--name] ... # Update a business
├── products
│ ├── list [--query] [--business] # Search products
│ ├── get <id> # Get a single product
│ ├── create [--name] [--price] ... # Create a product
│ ├── update <id> [--name] ... # Update a product
│ └── delete <id> # Delete a product
├── resources
│ ├── list / get / create / update / delete
├── bookings
│ ├── list / get / create / update / delete
├── coworkers
│ ├── list / get / create / update / delete / commands
└── ... (40+ entity types)
Global flags: --json | --md | --agent | --base-url <url>
New entity types are added regularly. Run nexudus --help to see all currently available commands, or run nexudus doctor --agent to get a
machine-readable list.
Global flags
These flags can be added to any command:
| Flag | Description |
|---|
--json | Output raw JSON envelope (for scripting) |
--md | Output as Markdown tables |
--agent | Output JSON envelope with enhanced summary (for AI assistants) |
--base-url <url> | Override the API base URL |
--yes or -y | Skip confirmation prompts (e.g., on delete) |
Common operations
Listing entities
nexudus products list
nexudus products list --query "Day Pass"
nexudus products list --business 12345678
nexudus products list --page 2 --size 50
--query filters results by name or keyword.--business scopes results to a specific business (location).--page and --size control pagination. Default page size is 25; use --size 100 for larger pages.
Getting a single entity
nexudus products get 12345678
List responses return a simplified projection without collection properties (e.g., Tariffs, Teams, LinkedResources). To see all fields including lists, always fetch the individual entity by ID with get <id>.
Creating an entity
nexudus products create --name "Day Pass" --price 25.00 --business 12345678
nexudus <entity> create --help to see all available options and which are required.
Updating an entity
nexudus products update 12345678 --name "Premium Day Pass" --price 35.00
Deleting an entity
nexudus products delete 12345678
--yes to skip the prompt in scripts:
nexudus products delete 12345678 --yes
Entity commands
Some entities support additional operations called “commands” (e.g., archiving, activating):
# Discover available commands for an entity type
nexudus products commands
# Run a command on one or more entities
nexudus products run-command archive 123,456,789
Working with list properties
Some entities have list properties (e.g., tariffs on a resource, teams on a coworker). To set these, repeat the flag for each value:
nexudus resources update 123 --tariffs 101 --tariffs 202 --tariffs 303
| Flag pattern | Behaviour |
|---|
--{list} | Replaces the entire list with the supplied values. Use this by default. |
--added-{list} | Adds values to the existing list without removing current entries. |
--removed-{list} | Removes specific values from the existing list. |
Do not use comma-separated values or bracket syntax for lists. Each value needs its own flag occurrence.
Image uploads
Some entities have image properties (logo, banner, picture). To set an image, provide a publicly accessible URL:
nexudus businesses update 123 --logo-url "https://example.com/logo.png"
nexudus resources update 456 --new-picture-url "https://example.com/room.jpg"
Discovering options
You can always check available options for any command by appending --help:
nexudus businesses update --help
nexudus products create --help
nexudus resources list --help
