swapperctl

A new CLI generated with oclif

• Usage
• Commands

Usage

$ npm install -g @swappableqm/swapperctl
$ swapperctl COMMAND
running command...
$ swapperctl (--version)
@swappableqm/swapperctl/0.0.2 linux-x64 node-v24.1.0
$ swapperctl --help [COMMAND]
USAGE
  $ swapperctl COMMAND
...

Commands

• swapperctl active
• swapperctl active overview
• swapperctl active stop
• swapperctl active sync
• swapperctl help [COMMAND]
• swapperctl qm
• swapperctl qm active
• swapperctl qm list
• swapperctl qm overview QMID
• swapperctl qm swap QMID

swapperctl active

View the current active QM and its' status

USAGE
  $ swapperctl active [--json] [--api-secret <value>] [--api-url <value>]

SWAPPER API FLAGS
  --api-secret=<value>  The API secret for the Swapper API server
  --api-url=<value>     The URL of the Swapper API server

OUTPUT FLAGS
  --json  Output in JSON format

DESCRIPTION
  View the current active QM and its' status

ALIASES
  $ swapperctl active overview
  $ swapperctl qm active

EXAMPLES
  $ swapperctl active

See code: src/commands/active/index.ts

swapperctl active overview

View the current active QM and its' status

USAGE
  $ swapperctl active overview [--json] [--api-secret <value>] [--api-url <value>]

SWAPPER API FLAGS
  --api-secret=<value>  The API secret for the Swapper API server
  --api-url=<value>     The URL of the Swapper API server

OUTPUT FLAGS
  --json  Output in JSON format

DESCRIPTION
  View the current active QM and its' status

ALIASES
  $ swapperctl active overview
  $ swapperctl qm active

EXAMPLES
  $ swapperctl active overview

swapperctl active stop

Stop the active QM

USAGE
  $ swapperctl active stop [--json] [--api-secret <value>] [--api-url <value>]

SWAPPER API FLAGS
  --api-secret=<value>  The API secret for the Swapper API server
  --api-url=<value>     The URL of the Swapper API server

OUTPUT FLAGS
  --json  Output in JSON format

DESCRIPTION
  Stop the active QM

EXAMPLES
  $ swapperctl active stop

See code: src/commands/active/stop.ts

swapperctl active sync

Sync devices to the active QM

USAGE
  $ swapperctl active sync [--json] [--api-secret <value>] [--api-url <value>]

SWAPPER API FLAGS
  --api-secret=<value>  The API secret for the Swapper API server
  --api-url=<value>     The URL of the Swapper API server

OUTPUT FLAGS
  --json  Output in JSON format

DESCRIPTION
  Sync devices to the active QM

EXAMPLES
  $ swapperctl active sync

See code: src/commands/active/sync.ts

swapperctl help [COMMAND]

Display help for swapperctl.

USAGE
  $ swapperctl help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for swapperctl.

See code: @oclif/plugin-help

swapperctl qm

View list of all swappable QMs

USAGE
  $ swapperctl qm [--json] [--api-secret <value>] [--api-url <value>]

SWAPPER API FLAGS
  --api-secret=<value>  The API secret for the Swapper API server
  --api-url=<value>     The URL of the Swapper API server

OUTPUT FLAGS
  --json  Output in JSON format

DESCRIPTION
  View list of all swappable QMs

ALIASES
  $ swapperctl qm list

EXAMPLES
  $ swapperctl qm

See code: src/commands/qm/index.ts

swapperctl qm active

View the current active QM and its' status

USAGE
  $ swapperctl qm active [--json] [--api-secret <value>] [--api-url <value>]

SWAPPER API FLAGS
  --api-secret=<value>  The API secret for the Swapper API server
  --api-url=<value>     The URL of the Swapper API server

OUTPUT FLAGS
  --json  Output in JSON format

DESCRIPTION
  View the current active QM and its' status

ALIASES
  $ swapperctl active overview
  $ swapperctl qm active

EXAMPLES
  $ swapperctl qm active

swapperctl qm list

View list of all swappable QMs

USAGE
  $ swapperctl qm list [--json] [--api-secret <value>] [--api-url <value>]

SWAPPER API FLAGS
  --api-secret=<value>  The API secret for the Swapper API server
  --api-url=<value>     The URL of the Swapper API server

OUTPUT FLAGS
  --json  Output in JSON format

DESCRIPTION
  View list of all swappable QMs

ALIASES
  $ swapperctl qm list

EXAMPLES
  $ swapperctl qm list

swapperctl qm overview QMID

View the current active QM and its' status

USAGE
  $ swapperctl qm overview QMID [--json] [--api-secret <value>] [--api-url <value>]

ARGUMENTS
  QMID  The ID of the QM to view

SWAPPER API FLAGS
  --api-secret=<value>  The API secret for the Swapper API server
  --api-url=<value>     The URL of the Swapper API server

OUTPUT FLAGS
  --json  Output in JSON format

DESCRIPTION
  View the current active QM and its' status

ALIASES
  $ swapperctl qm overview

EXAMPLES
  $ swapperctl qm overview

See code: src/commands/qm/overview.ts

swapperctl qm swap QMID

Swap the active QM

USAGE
  $ swapperctl qm swap QMID [--json] [--api-secret <value>] [--api-url <value>]

ARGUMENTS
  QMID  The ID of the QM to swap to

SWAPPER API FLAGS
  --api-secret=<value>  The API secret for the Swapper API server
  --api-url=<value>     The URL of the Swapper API server

OUTPUT FLAGS
  --json  Output in JSON format

DESCRIPTION
  Swap the active QM

ALIASES
  $ swapperctl qm swap

EXAMPLES
  $ swapperctl qm swap

See code: src/commands/qm/swap.ts