Skip to content

Reference

Troubleshooting

Fixes for common problems with installation, models, approvals, devices and Python.

First, check which version you’re running and which workspace and devices Kinex sees:

kinex --version
kinex run "/devices"

Installation and startup

ProblemFix
kinex: command not foundAdd ~/.local/bin to your PATH; the installer prints the exact line
Another Kinex is on PATHAnother kinex is installed and first on your PATH. Either keep it and run kinex update, or remove it and rerun the installer.
Refusing to replace ~/.local/bin/kinexA file the installer didn’t create is in the way. Move it, then reinstall.
Syntax errors, or Node.js too oldKinex needs Node.js 22.19 or newer. Rerun the installer to get one.
Unsupported option or --json was removedThe option changed in 1.0.0; see Changed in 1.0.0
--resume requires a terminalIn scripts, use --continue or --session <id> instead
AuthPathConflict~/.config/kinex/agent/auth.json holds credentials that Kinex expects in ~/.local/share/kinex/agent/auth.json. Move or merge them into the latter, delete the former, then restart.

Models and approvals

ProblemFix
Model not foundCheck the exact name in /model. --provider only works together with --model.
Authentication errorsRun /login again, or check the provider’s API-key environment variable
Local model doesn’t respondMake sure the model server is running before you start Kinex
Tool calls denied in a scripted runWithout a terminal, ask can’t prompt you, so calls are denied. Allow specific permissions in .kinex/kinex.json, or use --auto. See Permissions.

Devices

ProblemFix
device "x" is unloadedRun /load x.
Shows as loaded but doesn’t respondBeing marked as loaded doesn’t mean it’s connected. Run /ping x, then /unload x and /load x.
Loading failsFix the driver or connection, then /load again. Kinex never restarts a failed device on its own.
No robot is configuredNo valid .kinex/workspace.yaml was found: it’s missing or invalid. Check you’re in the right directory.
The wrong devices show upA .kinex/ folder closer to your current directory is hiding the one you meant
Old behavior after an updateDrivers and tools copied into the workspace override the updated ones. Refresh those copies.
stop_failedThe device couldn’t be stopped cleanly. New commands are blocked until it’s recovered; check the hardware, then unload and load it.

Python

ProblemFix
uv not foundInstall uv. It’s only needed to create the workspace’s Python environment.
A package is missingRun uv add --project .kinex/python <package>. Kinex doesn’t install new dependencies on its own.
closed_loop or settled not foundThese built-ins were removed. Replace their stage mappings and state with a bounded Python feedback loop.
Custom tool or skill is missingMove custom content to .kinex/tools/ or .kinex/skills/ (or the corresponding global directories). Singular custom directories are no longer searched.
Camera paths appear but no imagesPython reads do not attach images. Request output="file" and return the paths with finish(result, file=[...]).
Script finishes but motion continuesSuccessful execution does not stop submitted motion. Use stop_owned() in finally when exiting must stop it, or /stop manually.
Batch returns an error for one deviceInspect every devices() entry’s ok field. Other calls may have succeeded; a partial batch error does not raise automatically in Python.
ROS driver fails to importROS drivers use the system Python 3.12, not .kinex/python

Reporting an issue

Open an issue at stacx-lab/kinex/issues and include:

  • the output of kinex --version, your OS, and your Node.js and Python versions;
  • the command you ran, what you expected, and what happened, including the error;
  • whether the device is simulated or real.

Remove credentials and any private images first.

Search