overlane ci secret set | Overlane Docs

Stores a secret in the encrypted vault under an UPPER_SNAKE_CASE name a pipeline lists in secrets:. The value comes from an environment variable (–from-env) or standard input (–stdin), never an argument that would land in shell history. Values under 8 characters are refused because they cannot be masked in logs reliably. Setting a secret is a safety class: it needs an approval from an independent agent (evidence and a reason) or a person first.

Usage

overlane ci secret set name [--from-env VAR] [--stdin] [--dry-run]

Arguments

Argument	Required	Description
`name`	yes	The secret name, for example NPM_TOKEN

Flags

Flag	Type	Required	Description
`--from-env`	string	no	Read the value from this environment variable
`--stdin`	boolean	no	Read the value from standard input
`--dry-run`	boolean	no	Print the requests and file changes this command would make, then stop. Needs no credentials.

Examples

overlane ci secret set NPM_TOKEN --from-env NPM_TOKEN
overlane ci secret set NPM_TOKEN --stdin --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 ci secret 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": {
        "tenantId": {
          "type": "string"
        },
        "projectId": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        }
      },
      "required": [
        "tenantId",
        "projectId",
        "name",
        "updatedAt"
      ],
      "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.