envoke-cli 0.1.1

Resolve environment variables from a declarative YAML config file
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Config",
  "description": "Top-level envoke configuration, typically loaded from `envoke.yaml`.",
  "type": "object",
  "properties": {
    "variables": {
      "description": "Map of variable names to their definitions.",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/$defs/Variable"
      }
    }
  },
  "required": [
    "variables"
  ],
  "$defs": {
    "Source": {
      "description": "How to obtain the value for a variable in a given environment.\n\nExactly one of `literal`, `cmd`, `sh`, `template`, or `skip` must be\nspecified.",
      "type": "object",
      "properties": {
        "cmd": {
          "description": "A command to execute; stdout is captured and trimmed.",
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        },
        "literal": {
          "description": "A fixed string value.",
          "type": [
            "string",
            "null"
          ]
        },
        "sh": {
          "description": "A shell script to execute via `sh -c`; stdout is captured and trimmed.",
          "type": [
            "string",
            "null"
          ]
        },
        "skip": {
          "description": "When `true`, the variable is silently omitted from output.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "template": {
          "description": "A string with `{VAR_NAME}` placeholders resolved from other variables.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "Variable": {
      "description": "A single environment variable with per-environment sources.",
      "type": "object",
      "properties": {
        "default": {
          "description": "Fallback source used when the requested environment has no entry in\n`envs`.",
          "anyOf": [
            {
              "$ref": "#/$defs/Source"
            },
            {
              "type": "null"
            }
          ]
        },
        "description": {
          "description": "Human-readable description, rendered as a comment in output.",
          "type": [
            "string",
            "null"
          ]
        },
        "envs": {
          "description": "Map of environment names to value sources.",
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/Source"
          }
        }
      }
    }
  }
}