Top Level Arguments

The Datawire Connect Cloud Tools command line interface supports the following top-level arguments:

These arguments are all optional but must be specified in the order listed above if used.

-h

-h provides a list of available top level arguments and supported commands with a brief description of each.

Syntax

dwc -h

Equivalent Options

The following arguments are equivalent to -h:

  • –help

Constraints and Usage Notes

If -h is specified, nothing else in the command is evaluated.

Using -h as a top level argument does not provide any specifics about the requirements or arguments available for commands.

-v

-v increases the verbosity of the responses from the CLI.

Syntax

dwc -v ...

Equivalent Options

The following arguments are equivalent to -v:

  • –verbose

Constraints and Usage Notes

The -v flag has no meaning if used with -h.

The CLI supports XXX verbosity levels. By default, most commands that create items (organizations, users, services, tokens, etc.) return a handle to the newly created item.

-q

-q suppresses responses from the CLI.

Syntax

dwc -q ...

Equivalent Options

The following arguments are equivalent to -q:

  • –quiet

Constraints and Usage Notes

-q suppresses responses from the CLI. This may be useful if you are using the interface programmatically or want to maintain privacy and not display information specific to identifiers and tokens.

–registrar-url

–registrar-url specifies that the request should be handled by a specific Datawire Connect Identity Server as indicated by a specific fully qualified domain name or IP address.

Syntax

dwc ... --registrar-url <uri> ...

Equivalent Options

The following arguments are equivalent to –registrar-url:

  • –base-url
  • –baseurl

Constraints and Usage Notes

If this argument is omitted, https://identity.datawire.io is used by default.

–local

–local specifies that the request should be handled by a local Datawire Connect Identity Server.

Syntax

dwc ... --local ...

Equivalent Options

–local is the only way to specify this option.

Constraints and Usage Notes

Coming Soon

–state

–state specifies a location for the state file containing information about the current user’s organizations, identifiers, and services.

Syntax

dwc ... --state <path> ...

Equivalent Options

The following arguments are equivalent to –state:

  • –state-path

Constraints and Usage Notes

If this argument is omitted, ~/.datawire/datawire.json is used by default.