yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request 'clan/vars: Improve help for list subcommand' (#3576) from kenji/clan-core:ke-fix-vars-help into main

Browse Source 
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3576
This commit is contained in:
Mic92
2025-05-12 14:04:27 +00:00
parent ccb1f08345 a6f17f18a2
commit 17e5f63149
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
pkgs/clan-cli/clan_cli/vars/cli.py
View File

@@ -77,20 +77,22 @@ Examples:
f""" f"""
This subcommand allows listing all non-secret vars for a specific machine. This subcommand allows listing all non-secret vars for a specific machine.
The resulting list will be a json string with the name of the variable as its key The resulting list will be strings terminated by newlines as key-value pairs separated by a space.
and the variable itself as it's value.
This is how an example output might look like: This is how an example output might look like:
``` ```
\u007b [GENERATOR_NAME/VAR_1] [VALUE_1]
"[FACT_NAME]": "[FACT]" [GENERATOR_NAME/VAR_2] [VALUE_2]
\u007d
``` ```
Examples: Examples:
$ clan vars list [MACHINE] $ clan vars list [MACHINE]
Will list non-secret vars for the specified machine. Will list vars for the specified machine.
Secret vars will be masked by ******** and can be queried directly.
$ clan vars get [MACHINE] [GENERATOR_NAME/VAR]
This will print secret as well as public vars directly.
For more detailed information, visit: {help_hyperlink("vars", "https://docs.clan.lol/manual/vars-backend/")} For more detailed information, visit: {help_hyperlink("vars", "https://docs.clan.lol/manual/vars-backend/")}