Authentication
The Nexudus CLI authenticates against the Nexudus REST API using your Nexudus account email and password. Credentials are stored securely in your operating system’s native credential store.
Credential storage
| Operating system | Storage backend |
|---|
| Windows | Windows Credential Manager |
| macOS | macOS Keychain |
| Linux | libsecret (GNOME Keyring / KDE Wallet) |
Credentials are never stored in plain text on disk.
Log in
The CLI prompts you for your Nexudus email and password. After entering them, the CLI validates your credentials by calling the Nexudus API and stores them securely if successful.
The CLI currently uses Basic Authentication (username and password). OAuth/Bearer token support is planned for a future release.
Verify your session
This displays your authenticated user information including your name, email, and default business. It also returns useful defaults that commands use automatically:
| Default | Description |
|---|
DefaultBusinessId | Your primary business (location) ID |
DefaultCurrencyId | The default currency for your account |
DefaultCountryId | The default country for your account |
DefaultSimpleTimeZoneId | The default timezone for your account |
These defaults are used automatically when creating or updating entities so you don’t have to specify them every time.
Log out
This clears all stored credentials from your system’s secure storage.
Troubleshooting authentication
| Symptom | Solution |
|---|
| ”Not logged in” errors | Run nexudus login to authenticate |
| ”Unauthorized” errors | Your credentials may have changed — run nexudus login again |
| ”Forbidden” errors | Your account may not have API permissions — contact your Nexudus administrator |
Run nexudus doctor at any time to check whether you have stored credentials and whether the API is reachable.