From bdeb514eb1d9040aa84fe0a6b1a3d97234dbe523 Mon Sep 17 00:00:00 2001 From: a-kenji Date: Mon, 12 May 2025 14:46:41 +0200 Subject: [PATCH] clan/vars: Improve help for list subcommand Closes #3550 --- pkgs/clan-cli/clan_cli/vars/cli.py | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/pkgs/clan-cli/clan_cli/vars/cli.py b/pkgs/clan-cli/clan_cli/vars/cli.py index 75d3ff562..79495086a 100644 --- a/pkgs/clan-cli/clan_cli/vars/cli.py +++ b/pkgs/clan-cli/clan_cli/vars/cli.py @@ -77,20 +77,22 @@ Examples: f""" 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 -and the variable itself as it's value. +The resulting list will be strings terminated by newlines as key-value pairs separated by a space. This is how an example output might look like: ``` -\u007b -"[FACT_NAME]": "[FACT]" -\u007d +[GENERATOR_NAME/VAR_1] [VALUE_1] +[GENERATOR_NAME/VAR_2] [VALUE_2] ``` Examples: $ 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("secrets", "https://docs.clan.lol/getting-started/secrets")}