Troubleshoot Installation
Fix common issues you may encounter when installing the SDK.
Add --verbose (or -v) before the command name to see the SDK's INFO and DEBUG logs. It's a global option, so it must come before the command, not after.
haystack-enterprise Is Not Found
After uv tool install haystack-enterprise-sdk, the command lives in the uv tools directory, often ~/.local/bin on macOS and Linux. Add that directory to your PATH, or run uv tool update-shell and open a new terminal.
python -m haystack_enterprise_sdk.cli only works if that Python environment has the SDK installed, for example after uv add haystack-enterprise-sdk or pip install haystack-enterprise-sdk. A uv tool install does not add the package to your current Python.
python -m haystack_enterprise_sdk.cli --help
When this works, replace haystack-enterprise with python -m haystack_enterprise_sdk.cli for every command.
validate Reports a Missing Haystack Module
ModuleNotFoundError: No module named 'haystack'
This means the CLI environment has no Haystack, and the SDK found no project environment next to your pipeline file. To fix it, install the deploy extra, or use --python /path/to/python to point the CLI at the interpreter that has your pipeline's dependencies.
Related Information
Was this page helpful?