sklp secret

sklp secret

Description

Sync project secrets between core and a local dotenv file (push | pull | list | delete)

Subcommands

Technical details

Technical details

Raw command JSON

{
  "path": [
    "sklp",
    "secret"
  ],
  "slug": "secret",
  "name": "secret",
  "short": "Sync project secrets between core and a local dotenv file (push | pull | list | delete)",
  "synopsis": "sklp secret",
  "subcommands": [
    {
      "path": [
        "sklp",
        "secret",
        "delete"
      ],
      "slug": "secret-delete",
      "name": "delete",
      "short": "Delete a project secret by name",
      "synopsis": "sklp secret delete [flags] <name>",
      "flags": [
        {
          "name": "project",
          "usage": "project id (defaults to SKLP_PROJECT)",
          "type": "string",
          "envFallback": "SKLP_PROJECT"
        }
      ],
      "positionals": [
        {
          "name": "name",
          "required": true
        }
      ]
    },
    {
      "path": [
        "sklp",
        "secret",
        "list"
      ],
      "slug": "secret-list",
      "name": "list",
      "short": "List project secrets (name, last4, deploy-readable — never plaintext)",
      "synopsis": "sklp secret list [flags]",
      "flags": [
        {
          "name": "project",
          "usage": "project id (defaults to SKLP_PROJECT)",
          "type": "string",
          "envFallback": "SKLP_PROJECT"
        },
        {
          "name": "json",
          "usage": "emit raw JSON from the API",
          "type": "bool"
        },
        {
          "name": "plain",
          "usage": "emit TSV (one row per secret, no header)",
          "type": "bool"
        }
      ]
    },
    {
      "path": [
        "sklp",
        "secret",
        "pull"
      ],
      "slug": "secret-pull",
      "name": "pull",
      "short": "Fetch deploy-readable secrets into a local dotenv file",
      "synopsis": "sklp secret pull [flags] [file]",
      "flags": [
        {
          "name": "project",
          "usage": "project id (defaults to SKLP_PROJECT)",
          "type": "string",
          "envFallback": "SKLP_PROJECT"
        },
        {
          "name": "force",
          "usage": "skip the confirmation prompt when pulling into a non-default filename",
          "type": "bool"
        }
      ],
      "positionals": [
        {
          "name": "file",
          "required": false
        }
      ]
    },
    {
      "path": [
        "sklp",
        "secret",
        "push"
      ],
      "slug": "secret-push",
      "name": "push",
      "short": "Upload dotenv KEY=VALUE pairs to core",
      "synopsis": "sklp secret push [flags] [file]",
      "flags": [
        {
          "name": "project",
          "usage": "project id (defaults to SKLP_PROJECT)",
          "type": "string",
          "envFallback": "SKLP_PROJECT"
        },
        {
          "name": "deploy-readable",
          "usage": "opt the secret into `sklp deploy`/`secret pull` (default true for new secrets)",
          "type": "bool",
          "default": "true"
        },
        {
          "name": "dry-run",
          "usage": "print what would change, upload nothing",
          "type": "bool"
        }
      ],
      "positionals": [
        {
          "name": "file",
          "required": false
        }
      ]
    }
  ]
}

See also