Command-Line Interface Options

Global Options

Under normal circumstances, only info, warn and error logs are printed to the console. For development, you may also want to see debug logs.

  • log.level: The minimum level log messages must have to be shown

By default the CLI assumes that it is connecting to servers that use TLS certificates that are trusted by the operating system. When connecting to servers with self-signed certificates or a custom CA, the ca option can be used to trust those certificates. When connecting servers that don’t use TLS, the insecure option can be used.

  • ca: CA certificate file
  • insecure: Connect without TLS

The CLI can keep track of multiple configurations and multiple credentials. The credentials-id flag selects the set of credentials that are used to connect to servers. The login command registers the hosts that are configured at that moment, and will prevent leaking credentials to other hosts. This can be circumvented with the allow-unknown-hosts option.

  • credentials-id: Credentials ID (if using multiple configurations)
  • allow-unknown-hosts: Allow sending credentials to unknown hosts

By default the CLI uses JSON as the input and output format. It is also possible to use a Go template as output format.

  • input-format: Input format
  • output-format: Output format

API Options

The CLI needs to be configured with the addresses of the OAuth server. The Getting Started guide gives a good example configuration for a typical deployment.

  • oauth-server-address: OAuth Server address
  • identity-server-grpc-address: Identity Server address
  • gateway-server-enabled: Gateway Server enabled
  • gateway-server-grpc-address: Gateway Server address
  • network-server-enabled: Network Server enabled
  • network-server-grpc-address: Network Server address
  • application-server-enabled: Application Server enabled
  • application-server-grpc-address: Application Server address
  • join-server-enabled: Join Server enabled
  • join-server-grpc-address: Join Server address
  • device-claiming-server-grpc-address: Device Claiming Server address
  • device-template-converter-grpc-address: Device Template Converter address
  • qr-code-generator-grpc-address: QR Code Generator address
← Application Server Options Console Options →