planqk-cli
The PlanQK Command Line Interface (CLI) lets you interact with the PlanQK Platform directly from your terminal.
We have installation instructions to guide you through the initial setup in our
quickstart guide.
Detailed information about the supported commands can be found in our
CLI reference.
Installation
To install the PlanQK CLI, you must install Node.js and the npm command line interface using either a
Node version manager or a Node installer.
Make sure you install Node.js version 18 or higher.
Then install the PlanQK CLI globally using npm:
npm install -g @planqk/planqk-cli
IMPORTANT: Make sure you have uninstalled the deprecated CLI:
npm uninstall -g @anaqor/planqk
You can use the --help
flag to get information about the supported commands:
planqk --help
You may also get information about a specific command:
planqk <command> --help
Troubleshooting:
If you experience EACCES permissions errors during installation, we recommend using Node version manager (nvm).
Further, you may refer to the official npm documentation how to resolve such issues.
License
Apache-2.0 | Copyright 2023-2024 Kipu Quantum GmbH