Skip to content

Help center/CLI & automation

Connect and use the CLI

Set up a profile, validate access and discover commands from your terminal.

Prepare the CLI and connection details

Install the Cynexio Skill package for the computer where your AI assistant runs. It includes a ready-to-run CLI; no compiler, separate CLI installation or PATH setup is needed.

Download and install the Skill with CLI included

Your assistant resolves the launcher inside the installed Skill. The examples below use cynexio as shorthand for that launcher. To run them yourself, replace cynexio with sh /absolute/path/to/cynexio/scripts/cynexio on macOS/Linux, or use scripts/cynexio.ps1 on Windows. This example uses the Codex Skills directory:

Open the bundled CLI help
sh ~/.codex/skills/cynexio/scripts/cynexio --help

For connection, you need your backend URL, tenant code and a developer key. Ask your administrator for the URL and tenant. The backend address may differ from the website address.

Connect with your developer key

Replace the example URL and tenant code with your own. Supply the key through standard input from a trusted secret source; do not put the value directly in the command. The work profile keeps this connection separate from other environments.

Authenticate and verify
cynexio auth login --key-stdin \
  --base-url https://your-be.example \
  --tenant your-tenant --profile work
cynexio auth validate --profile work
cynexio auth whoami --profile work
cynexio capabilities --profile work

Check the returned identity and capabilities before working with data. Include --profile work in later commands if you use this named profile. Credentials use the supported system credential store; login refuses to save them if secure storage is unavailable.

Find commands and resource IDs

Explore without changing data
cynexio --help
cynexio table create --help
cynexio schema record list --json
cynexio app list --profile work
cynexio table list --app 1234567890123456789 --profile work

Help and command schemas work without signing in. Resource commands require access. Use the returned application, table and field IDs in later commands; the example IDs in this documentation are illustrative.

Use output in scripts

Commands return structured JSON by default, with ok, data and meta. Use --output table for a readable terminal view or supported CSV/NDJSON output for downstream tools. Errors and progress go to stderr. Preserve IDs and exact decimal values as strings.

Remove the local credential
cynexio auth logout --profile work

Logout removes the local credential for that profile. To stop the key itself, revoke it in Settings → Developer keys.