Skip to content

Commit bff6709

Browse files
committed
docs(): schemas alias
1 parent 875d35b commit bff6709

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

content/CLI/cli-config.mdx

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ Example `.configu` file in JSON format:
3535
}
3636
}
3737
},
38+
"schemas": {
39+
"common": "path/to/common.cfgu.json",
40+
"api": "path/to/api.cfgu.json"
41+
},
3842
"scripts": {
3943
"script1": "configu command1 --option1 value1",
4044
"script2": "configu command2 --option2 value2 | configu command3"
@@ -58,6 +62,9 @@ stores:
5862
configuration:
5963
option3: value3
6064
option4: value4
65+
schemas:
66+
common: 'path/to/common.cfgu.json'
67+
api: 'path/to/api.cfgu.json'
6168
scripts:
6269
script1: 'configu command1 --option1 value1'
6370
script2: 'configu command2 --option2 value2 | configu command3'
@@ -85,6 +92,10 @@ module.exports = {
8592
},
8693
},
8794
},
95+
schemas: {
96+
common: "path/to/common.cfgu.json",
97+
api: "path/to/api.cfgu.json"
98+
},
8899
scripts: {
89100
script1: 'configu command1 --option1 value1',
90101
script2: 'configu command2 --option2 value2 | configu command3',
@@ -102,6 +113,14 @@ To define a custom store, add a new key-value pair to the `stores` section of th
102113

103114
For detailed information about the available store options, please refer to the relevant store on the [`ConfigStore`](/config-store) page.
104115

116+
### Schemas
117+
118+
The `.configu` file allows you to save paths to `*.cfgu.json` schema files as friendly names, which can be later used as values for the `--schema` flag in all the commands.
119+
120+
To define a custom schema, add a new key-value pair to the `schemas` section of the `.configu` file, where the key represents the friendly name, and the value is a string containing the relative or absolute path to the schema file.
121+
122+
For detailed information about schema files, please refer to [`ConfigSchema`](/config-schema) page.
123+
105124
### Scripts
106125

107126
The `.configu` file allows you to save `Configu CLI` snippets as friendly names, which can be later used as values for the `--script` flag in the `configu run --script <label>` command.

0 commit comments

Comments
 (0)