NuKVM/xen-orchestra
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore(xo-cli/USAGE): clearer JSON param explanation

Browse Source
This commit is contained in:
Julien Fontanet
2021-02-16 10:51:53 +01:00
parent ef25b364ec
commit fb4dff4fca
2 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
packages/xo-cli/README.md
View File

@@ -97,12 +97,11 @@ E.g., adding a new server:
The return value is the identifier of this new server in XO.
Parameters (except `true` and `false` which are correctly parsed as
booleans) are assumed to be strings, for other types, you may use JSON
encoding by prefixing with `json:`:
Because command lines are usually untyped, parameters (except `true` and `false` which are considered as
booleans) are assumed as strings by default, other types must be encoded as JSON and prefixed by `json:`:
```
> xo-cli foo.bar baz='json:[1, 2, 3]'
> xo-cli method string=foo number=json:42 array=json:'["item1", "item2"]'
```
##### Configuration export

7
packages/xo-cli/USAGE.md
View File

@@ -79,12 +79,11 @@ E.g., adding a new server:
The return value is the identifier of this new server in XO.
Parameters (except `true` and `false` which are correctly parsed as
booleans) are assumed to be strings, for other types, you may use JSON
encoding by prefixing with `json:`:
Because command lines are usually untyped, parameters (except `true` and `false` which are considered as
booleans) are assumed as strings by default, other types must be encoded as JSON and prefixed by `json:`:
```
> xo-cli foo.bar baz='json:[1, 2, 3]'
> xo-cli method string=foo number=json:42 array=json:'["item1", "item2"]'
```
##### Configuration export