@anaqor/planqk

planqk-cli

• Usage
• Commands

Usage

$ npm install -g @anaqor/planqk
$ planqk COMMAND
running command...
$ planqk (--version)
@anaqor/planqk/1.8.0 linux-x64 node-v16.16.0
$ planqk --help [COMMAND]
USAGE
  $ planqk COMMAND
...

Commands

• planqk autocomplete [SHELL]
• planqk get-context
• planqk init
• planqk list-contexts
• planqk login
• planqk logout
• planqk run [SERVICEID]
• planqk services
• planqk set-context [CONTEXTID]
• planqk up

planqk autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ planqk autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ planqk autocomplete

  $ planqk autocomplete bash

  $ planqk autocomplete zsh

  $ planqk autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

planqk get-context

Get the current context, i.e., the personal or organization account you are currently working with.

USAGE
  $ planqk get-context

DESCRIPTION
  Get the current context, i.e., the personal or organization account you are currently working with.

EXAMPLES
  $ planqk get-context

See code: dist/commands/get-context/index.ts

planqk init

Initialize a PlanQK project.

USAGE
  $ planqk init

DESCRIPTION
  Initialize a PlanQK project.

EXAMPLES
  $ planqk init

See code: dist/commands/init/index.ts

planqk list-contexts

Retrieves the available contexts, i.e., the personal or organizational accounts you are currently working with.

USAGE
  $ planqk list-contexts

DESCRIPTION
  Retrieves the available contexts, i.e., the personal or organizational accounts you are currently working with.

EXAMPLES
  $ planqk list-contexts

See code: dist/commands/list-contexts/index.ts

planqk login

Login with your PlanQK Platform credentials

USAGE
  $ planqk login [--help] [-t <value>]

FLAGS
  -t, --token=<value>  Your personal access token
  --help               Show CLI help.

DESCRIPTION
  Login with your PlanQK Platform credentials

EXAMPLES
  $ planqk login -t <personal access token>

See code: dist/commands/login/index.ts

planqk logout

Logout of the PlanQK Platform

USAGE
  $ planqk logout [--help]

FLAGS
  --help  Show CLI help.

DESCRIPTION
  Logout of the PlanQK Platform

EXAMPLES
  $ planqk logout

See code: dist/commands/logout/index.ts

planqk run [SERVICEID]

Creates a job execution of a PlanQK Service

USAGE
  $ planqk run [SERVICEID] [-d <value>] [-p <value>] [--data-file <value>] [--params-file <value>]
    [--detached]

FLAGS
  -d, --data=<value>     Input data as JSON string.
  -p, --params=<value>   Parameters as JSON string.
  --data-file=<value>    Relative path to file containing input data.
  --detached             Executes the job in detached mode, i.e., without waiting for it to finish.
  --params-file=<value>  Relative path to file containing params.

DESCRIPTION
  Creates a job execution of a PlanQK Service

EXAMPLES
  $ planqk run

  $ planqk run --detached

  $ planqk run -d '{"values": [10,12]}' -p '{"round_up": true}'

  $ planqk run --data-file=./input/data.json --params-file=./input/params.json

See code: dist/commands/run/index.ts

planqk services

List all available services

USAGE
  $ planqk services

DESCRIPTION
  List all available services

EXAMPLES
  $ planqk services

See code: dist/commands/services/index.ts

planqk set-context [CONTEXTID]

Set the current context, i.e., the personal or organization account you are currently working with.

USAGE
  $ planqk set-context [CONTEXTID]

DESCRIPTION
  Set the current context, i.e., the personal or organization account you are currently working with.

EXAMPLES
  $ planqk set-context

  $ planqk set-context <context-id>

See code: dist/commands/set-context/index.ts

planqk up

Creates or updates a PlanQK Service

USAGE
  $ planqk up

DESCRIPTION
  Creates or updates a PlanQK Service

EXAMPLES
  $ planqk up

See code: dist/commands/up/index.ts