verdict profile add

Source command definition

Save an instance connection without changing the selected profile

Runs locally. Effects: write stored profile and credential.

Arguments and flags

Argument	Type	Required	Default	Description
<name>	positional	yes	No parser default	Profile name
--endpoint	string	no	No parser default	Instance base URL, including any subpath (env: VERDICT_HOST, fallback: http://localhost:4891)
--host	string	no	No parser default	Alias for —endpoint
--auth	boolean	no	true	Prompt for an API key; —no-auth saves an unauthenticated endpoint
--api-key-stdin	boolean	no	false	Read the API key from standard input
--force	boolean	no	false	Replace an existing profile and credential
--json	boolean	no	false	Output as JSON

--help (-h) shows command help without executing the command. Boolean flags support --no-<flag>. Defaults stated in descriptions may be resolved by the handler or configuration rather than the argument parser.

Input

Profile name and connection flags. —endpoint or —host is required. Read an API key with —api-key-stdin or the interactive prompt; —api-key-stdin cannot be combined with —no-auth.

File input: unsupported. Standard input: supported.

• With —json, use —api-key-stdin or —no-auth.

Result

{
  "kind": "json-schema",
  "schema": {
    "type": "object",
    "required": [
      "completed",
      "warnings"
    ],
    "additionalProperties": false,
    "properties": {
      "completed": {
        "type": "boolean"
      },
      "name": {
        "type": "string",
        "nullable": true
      },
      "target": {
        "type": "string",
        "enum": [
          "global",
          "project"
        ],
        "nullable": true
      },
      "warnings": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  }
}

By default, the command renders human-readable records. --json writes one JSON result to stdout. Operational failures use status 1; JSON failures contain an error object with code and message. See shared output semantics.

Exit status

• 0: the command completed its operation.

Argument, I/O, and other failures handled by the CLI runner use status 1.

Examples

verdict profile add development --endpoint http://localhost:4891 --no-auth --json