From 2db14e0ffae8f02bafd677a9bacd83b3470c871b Mon Sep 17 00:00:00 2001 From: Michael Hoang Date: Thu, 3 Apr 2025 00:06:06 +0900 Subject: [PATCH 1/2] cli: `machines update [MACHINE]` -> `machines update [MACHINES]` --- pkgs/clan-cli/clan_cli/__init__.py | 2 +- pkgs/clan-cli/clan_cli/machines/cli.py | 4 ++-- pkgs/clan-cli/clan_cli/machines/update.py | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/pkgs/clan-cli/clan_cli/__init__.py b/pkgs/clan-cli/clan_cli/__init__.py index bb67c6c9d..5737aa25e 100644 --- a/pkgs/clan-cli/clan_cli/__init__.py +++ b/pkgs/clan-cli/clan_cli/__init__.py @@ -352,7 +352,7 @@ Examples: List all the machines managed by clan. $ clan machines update [MACHINES] - Will update the specified machine [MACHINE], if [MACHINE] is omitted, the command + Will update the specified machines [MACHINES], if [MACHINES] is omitted, the command will attempt to update every configured machine. $ clan machines install [MACHINE] --target-host [TARGET_HOST] diff --git a/pkgs/clan-cli/clan_cli/machines/cli.py b/pkgs/clan-cli/clan_cli/machines/cli.py index 7e98b21d0..0d323227f 100644 --- a/pkgs/clan-cli/clan_cli/machines/cli.py +++ b/pkgs/clan-cli/clan_cli/machines/cli.py @@ -24,7 +24,7 @@ def register_parser(parser: argparse.ArgumentParser) -> None: update_parser = subparser.add_parser( "update", - help="Update a machine", + help="Update one or more machines", epilog=( """ This subcommand provides an interface to update machines managed by clan. @@ -32,7 +32,7 @@ This subcommand provides an interface to update machines managed by clan. Examples: $ clan machines update [MACHINES] - Will update the specified machine [MACHINE], if [MACHINE] is omitted, the command + Will update the specified machines [MACHINES], if [MACHINES] is omitted, the command will attempt to update every configured machine. To exclude machines being updated `clan.deployment.requireExplicitUpdate = true;` can be set in the machine config. diff --git a/pkgs/clan-cli/clan_cli/machines/update.py b/pkgs/clan-cli/clan_cli/machines/update.py index 60b1eeabb..1f84ad347 100644 --- a/pkgs/clan-cli/clan_cli/machines/update.py +++ b/pkgs/clan-cli/clan_cli/machines/update.py @@ -278,7 +278,7 @@ def register_update_parser(parser: argparse.ArgumentParser) -> None: nargs="*", default=[], metavar="MACHINE", - help="Machine to update. If no machine is specified, all machines will be updated.", + help="Machine to update. If no machines are specified, all machines that don't require explicit updates will be updated.", ) add_dynamic_completer(machines_parser, complete_machines) From bbe12002d8bdcedd4ba4bf9255dce87b2c0c27b7 Mon Sep 17 00:00:00 2001 From: Michael Hoang Date: Thu, 3 Apr 2025 00:25:20 +0900 Subject: [PATCH 2/2] cli: `managed by clan` -> `managed by Clan` --- pkgs/clan-cli/clan_cli/__init__.py | 10 +++++----- pkgs/clan-cli/clan_cli/machines/cli.py | 4 ++-- pkgs/clan-cli/clan_cli/state/__init__.py | 4 ++-- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/pkgs/clan-cli/clan_cli/__init__.py b/pkgs/clan-cli/clan_cli/__init__.py index 5737aa25e..98e85191a 100644 --- a/pkgs/clan-cli/clan_cli/__init__.py +++ b/pkgs/clan-cli/clan_cli/__init__.py @@ -344,12 +344,12 @@ For more detailed information, visit: {help_hyperlink("secrets", "https://docs.c description="Manage machines and their configuration", epilog=( f""" -This subcommand provides an interface to machines managed by clan. +This subcommand provides an interface to machines managed by Clan. Examples: $ clan machines list - List all the machines managed by clan. + List all the machines managed by Clan. $ clan machines update [MACHINES] Will update the specified machines [MACHINES], if [MACHINES] is omitted, the command @@ -410,9 +410,9 @@ Examples: description="Query state information about machines", epilog=( f""" -This subcommand provides an interface to the state managed by clan. +This subcommand provides an interface to the state managed by Clan. -State can be folders and databases that modules depend on managed by clan. +State can be folders and databases that modules depend on managed by Clan. State directories can be added to on a per machine basis: ``` @@ -427,7 +427,7 @@ can be a good choice. Examples: $ clan state list [MACHINE] - List state of the machines managed by clan. + List state of the machines managed by Clan. For more detailed information, visit: {help_hyperlink("getting-started", "https://docs.clan.lol/backups")} """ diff --git a/pkgs/clan-cli/clan_cli/machines/cli.py b/pkgs/clan-cli/clan_cli/machines/cli.py index 0d323227f..10d88776e 100644 --- a/pkgs/clan-cli/clan_cli/machines/cli.py +++ b/pkgs/clan-cli/clan_cli/machines/cli.py @@ -27,7 +27,7 @@ def register_parser(parser: argparse.ArgumentParser) -> None: help="Update one or more machines", epilog=( """ -This subcommand provides an interface to update machines managed by clan. +This subcommand provides an interface to update machines managed by Clan. Examples: @@ -110,7 +110,7 @@ Installing a machine means overwriting the target's disk. """, epilog=( """ -This subcommand provides an interface to install machines managed by clan. +This subcommand provides an interface to install machines managed by Clan. Examples: diff --git a/pkgs/clan-cli/clan_cli/state/__init__.py b/pkgs/clan-cli/clan_cli/state/__init__.py index 8001e732e..c68569013 100644 --- a/pkgs/clan-cli/clan_cli/state/__init__.py +++ b/pkgs/clan-cli/clan_cli/state/__init__.py @@ -18,7 +18,7 @@ def register_parser(parser: argparse.ArgumentParser) -> None: description="list state folders and the services that configure them", epilog=( """ - List state of the machines managed by clan. + List state of the machines managed by Clan. The backup commands are commands that will exist on the deployed machine. They can be introspected by checking under `/run/current-system/sw/bin/[COMMAND]` @@ -26,7 +26,7 @@ def register_parser(parser: argparse.ArgumentParser) -> None: Examples: $ clan state list [MACHINE] - List state of the machine [MACHINE] managed by clan. + List state of the machine [MACHINE] managed by Clan. For more detailed information, visit: https://docs.clan.lol/getting-started/backups/