Contents

CLI Client

Capabilities and completion

Contents

The capabilities command

Using the capabilities command allows you to see the capabilities of the cloud platform the Scalable Pixel Streaming server is running on. Currently there are two main features that differ between cloud platforms.

  1. Image building support - Does the Scalable Pixel Streaming installation support building projects from a compressed zip using the --archive and what OS platforms are supported
  2. Runtime support - What operating systems does the Scalable Pixel Streaming installation support when running containers

You can query the capabilities using the following command:

sps-client capabilities

The output should look similar to the following:

{
        "server": "local",
        "method": "GET",
        "endpoint": "http://my-sps-server.com/api/v1/capabilities",
        "statusCode": 200,
        "status": "200 OK",
        "response": {
                "build": {
                        "Platforms": [
                                {
                                        "encapsulation": "container",
                                        "platform": "linux"
                                },
                                {
                                        "encapsulation": "reference",
                                        "platform": "linux"
                                }
                        ]
                },
                "runtime": {
                        "Platforms": [
                                {
                                        "encapsulation": "container",
                                        "platform": "linux"
                                },
                                {
                                        "encapsulation": "container",
                                        "platform": "windows"
                                }
                        ]
                }
        }
}

Flags

The following flags are available for the capabilities command:

  • --all-servers - Run command on all servers registered
  • -d, --dry-run - Output the JSON payload of the command without executing it
  • -h, --help - help for capabilities
  • --server - Run command on a specific server
  • --config - allow overriding the location that the configuration file is loaded from

The completion command

Using the completion command allows you to generate the autocompletion script for SPS Client for a specified shell.

Commands

The following sub-commands are available for the completion command:

  • bash - generate the autocompletion script for bash
  • fish - generate the autocompletion script for fish
  • powershell - generate the autocompletion script for powershell
  • zsh - generate the autocompletion script for zsh

See each sub-command’s help for details on how to use the generated script.

Flags

The following flags are available for the completion command:

  • -h, --help - help for completion
  • --config - allow overriding the location that the configuration file is loaded from