Skip to content

Quantum from your terminal

qhubctl is the Kipu Quantum Hub command line. Run optimization jobs, deploy services as production REST APIs, and manage quantum endpoints. No circuits, just answers.

Installs in under a minute. Requires Node.js. Full CLI reference

qhubctl cheat sheet

Authenticate

  • qhubctl login -t <token>

    Sign in with an access token from the Hub.

  • qhubctl logout

    Clear stored credentials.

  • qhubctl get-context

    Show the active organisation and project.

  • qhubctl set-context

    Switch the active organisation or project.

Build

  • qhubctl init

    Bootstrap a project to create a service.

  • qhubctl serve

    Run locally with the same HTTP endpoints.

  • qhubctl openapi

    Generate an OpenAPI description from your types.

  • qhubctl compress

    Package the current project into a ZIP.

Deploy & run

  • qhubctl up

    Create or update a live service endpoint.

  • qhubctl run <serviceId>

    Create a job execution against a service.

  • qhubctl services list

    List all services in the current context.

  • qhubctl services build-status

    Show a service build status.

  • qhubctl services build-logs

    Stream a service build's logs.

  • qhubctl datapool upload

    Upload files to a data pool.

Send me the PDF

Questions, answered

What is qhubctl?

qhubctl is the command-line interface for the Kipu Quantum Hub. From your terminal you can authenticate, scaffold a service project, run it locally, deploy it as a live REST endpoint, and submit jobs to the Hub's pre-built quantum solvers. It is the scriptable, CI-friendly companion to the Hub web app and the Hub MCP server.

How do I install the Kipu Quantum CLI?

Install it globally from npm with: npm i -g @quantum-hub/qhubctl. It runs on any machine with Node.js, so the same workflow works on macOS, Linux and Windows, and in CI pipelines.

How do I authenticate?

Run qhubctl login -t followed by your access token. You generate the token after signing in at login.hub.kipu-quantum.com. Run qhubctl logout to clear your credentials. Organisation and project context is managed with qhubctl get-context and qhubctl set-context.

Can I run a service locally before deploying?

Yes. qhubctl serve runs your project locally via qhub-serve and exposes the same HTTP endpoints it will have in production, so you can test against the real interface before shipping. qhubctl up then creates or updates the live service.

How do I run a quantum solver from the command line?

qhubctl services list shows the solvers available in your context, including Kipu's own services such as Miray and Rimay alongside 20-plus pre-built solvers and industry baselines. qhubctl run with a service id and an input file creates a job execution and returns a result you can pipe straight into the rest of your stack.

Do I need quantum computing knowledge to use it?

No. The CLI returns production-ready results as JSON with business outcomes rather than raw circuits, so you submit a problem and read back an answer. Pre- and post-processing are managed by the Hub.

Is the CLI suitable for automation and agents?

Yes. Every command supports non-interactive use and JSON output, so qhubctl fits cleanly into CI pipelines and scripts. qhubctl openapi generates an OpenAPI description of your service, and the same endpoints are callable by AI agents through the Kipu Quantum Hub MCP server.

Create an account, grab a token, and connect to quantum hardware

Create a free accountRead the documentation

Generate your access token after signing in at login.hub.kipu-quantum.com