test
Verify that the CLI can reach your workspace and that your token is valid.
The command runs a single small graph query (MapAsync("_User", "UserName")) and prints the user count. If you see a number, your credentials and connectivity are fine.
Syntax
Usage: curiosity-cli test --server <url> --token <token> [--timeout <seconds>]
curiosity-cli test \
--server https://my-workspace.example.com/ \
--token $CURIOSITY_TOKEN
Options
| Option | Description |
|---|---|
--server |
Workspace URL. See Common Options. Alias -s. |
--token |
Library Token. Pass auto to use a stored token (see store-token). Alias -t. |
--timeout |
Per-request timeout in seconds. Default 90. |
Sample output
info: Curiosity.CLI.Program[0]
Server responded to test query, there are 42 users in the system
When to use it
- In CI, run
testimmediately afterwait-forto confirm the workspace is not just up but also accepting authenticated calls. - In a new shell, run
testto validate a freshly created token before scripting longer-running commands. - After workspace upgrades, run
testto catch authentication regressions early.
Remarks
- Use
testas a lightweight credential and connectivity check before running longer commands; it only issues one small read query. - Requires a valid
--serverURL and a Library Token (orautofor a stored token). - A successful run prints the user count but makes no changes to the workspace.
See also
- Common Options
wait-for— block until the workspace is ready, then runtest.store-token— avoid passing tokens on the command line every time.