overlane inbox preferences set

Sets, for each –set KIND=CHANNEL, how you are told about that kind of event. Kinds: ci_failed, deploy_failed, deploy_rolled_back, approval_requested, alert_fired, run_error, digest, import_finished. Channels: in_app, email, none. Kinds you do not name keep their choice. Repeat –set for several kinds.

Usage

overlane inbox preferences set --set KIND=CHANNEL... [--service URL] [--dry-run]

Flags

Flag	Type	Required	Description
`--set`	string (repeatable)	yes	A kind and a channel (in_app, email, none), for example deploy_failed=email
`--service`	string	no	The service address (default: OVERLANE_SERVICE_URL, then the project’s binding, then the hosted service)
`--dry-run`	boolean	no	Print the requests and file changes this command would make, then stop. Needs no credentials.

Examples

overlane inbox preferences set --set deploy_failed=email
overlane inbox preferences set --set digest=none --set ci_failed=in_app --dry-run

Behavior

Effect: write (changes local or hosted state).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: yes. Accepts --force: no.
Machine-readable description: overlane schema inbox preferences set.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "preferences": {
          "type": "object",
          "propertyNames": {
            "type": "string",
            "enum": [
              "ci_failed",
              "deploy_failed",
              "deploy_rolled_back",
              "approval_requested",
              "alert_fired",
              "run_error",
              "digest",
              "import_finished"
            ]
          },
          "additionalProperties": {
            "type": "string",
            "enum": [
              "in_app",
              "email",
              "none"
            ]
          },
          "required": [
            "ci_failed",
            "deploy_failed",
            "deploy_rolled_back",
            "approval_requested",
            "alert_fired",
            "run_error",
            "digest",
            "import_finished"
          ]
        }
      },
      "required": [
        "preferences"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "dryRun": {
          "type": "boolean",
          "const": true
        },
        "service": {
          "type": "string"
        },
        "requests": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string"
              },
              "path": {
                "type": "string"
              },
              "body": {},
              "note": {
                "type": "string"
              }
            },
            "required": [
              "method",
              "path"
            ],
            "additionalProperties": false
          }
        },
        "commands": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "writes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "action": {
                "type": "string",
                "enum": [
                  "write",
                  "append",
                  "delete"
                ]
              },
              "description": {
                "type": "string"
              }
            },
            "required": [
              "path",
              "action",
              "description"
            ],
            "additionalProperties": false
          }
        },
        "notes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "dryRun",
        "requests",
        "commands",
        "writes",
        "notes"
      ],
      "additionalProperties": false
    }
  ]
}

See exit codes for the status the process returns.