All checks were successful
buildbot/nix-build .#checks.aarch64-darwin.nixos-test_install_machine Build done.
buildbot/nix-build .#checks.aarch64-darwin.nixos-flash-installer Build done.
buildbot/nix-build .#checks.aarch64-darwin.nixos-iso-installer Build done.
buildbot/nix-build .#checks.aarch64-linux.nixos-test_install_machine Build done.
buildbot/nix-build .#checks.aarch64-linux.nixos-iso-installer Build done.
buildbot/nix-build .#checks.x86_64-linux.devShell-webview-ui Build done.
buildbot/nix-build .#checks.aarch64-linux.nixos-flash-installer Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-nix Build done.
buildbot/nix-build .#checks.x86_64-linux."clan-dep-python3.11-qemu" Build done.
buildbot/nix-build .#checks.x86_64-linux.package-clan-cli-docs Build done.
buildbot/nix-build .#checks.x86_64-linux.package-clan-ts-api Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-app-no-breakpoints Build done.
buildbot/nix-build .#checks.x86_64-linux.package-gui-installer-apk Build done.
buildbot/nix-build .#checks.x86_64-linux.package-gui-installer-archlinux Build done.
buildbot/nix-build .#checks.x86_64-linux.package-gui-installer-deb Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-age Build done.
buildbot/nix-build .#checks.x86_64-linux.package-module-docs Build done.
buildbot/nix-build .#checks.x86_64-linux.package-gui-installer-rpm Build done.
buildbot/nix-build .#checks.x86_64-linux.package-default Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-bash Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-e2fsprogs Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-fakeroot Build done.
buildbot/nix-build .#checks.aarch64-darwin.nixos-test-backup Build done.
buildbot/nix-build .#checks.aarch64-linux.nixos-test-backup Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-git Build done.
buildbot/nix-build .#checks.x86_64-linux.renderClanOptions Build done.
buildbot/nix-build .#checks.x86_64-linux.check-for-breakpoints Build done.
buildbot/nix-build .#checks.x86_64-linux.package-clan-cli Build done.
buildbot/nix-build .#checks.x86_64-linux."clan-dep-python3.11-mypy" Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-openssh Build done.
buildbot/nix-build .#checks.x86_64-linux.devShell-docs Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-rsync Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-sshpass Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-sops Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-tor Build done.
buildbot/nix-build .#checks.x86_64-linux.nixos-test-backup Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-zbar Build done.
buildbot/nix-build .#checks.x86_64-linux.devShell-clan-cli Build done.
buildbot/nix-build .#checks.x86_64-linux.deltachat Build done.
buildbot/nix-build .#checks.x86_64-linux.matrix-synapse Build done.
buildbot/nix-build .#checks.x86_64-linux.nixos-test_install_machine Build done.
buildbot/nix-build .#checks.x86_64-linux.package-editor Build done.
buildbot/nix-build .#checks.x86_64-linux.package-merge-after-ci Build done.
buildbot/nix-build .#checks.x86_64-linux.treefmt Build done.
buildbot/nix-build .#checks.x86_64-linux.module-schema Build done.
buildbot/nix-build .#checks.x86_64-linux.package-zerotier-members Build done.
buildbot/nix-build .#checks.x86_64-linux.package-zerotierone Build done.
buildbot/nix-build .#checks.x86_64-linux.package-zt-tcp-relay Build done.
buildbot/nix-build .#checks.x86_64-linux.package-moonlight-sunshine-accept Build done.
buildbot/nix-build .#checks.x86_64-linux.package-function-schema Build done.
buildbot/nix-build .#checks.x86_64-linux.devShell-default Build done.
buildbot/nix-build .#checks.x86_64-linux.container Build done.
buildbot/nix-build .#checks.x86_64-linux.lib-jsonschema-example-valid Build done.
buildbot/nix-build .#checks.x86_64-linux.lib-jsonschema-nix-unit-tests Build done.
buildbot/nix-build .#checks.x86_64-linux.borgbackup Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-app-pytest Build done.
buildbot/nix-build .#checks.x86_64-linux.package-deploy-docs Build done.
buildbot/nix-build .#checks.x86_64-linux.package-impure-checks Build done.
buildbot/nix-build .#checks.x86_64-linux.package-tea-create-pr Build done.
buildbot/nix-build .#checks.x86_64-linux.syncthing Build done.
buildbot/nix-build .#checks.x86_64-linux.package-docs Build done.
buildbot/nix-build .#checks.x86_64-linux.package-webview-ui Build done.
buildbot/nix-build .#checks.x86_64-linux.package-clan-app Build done.
buildbot/nix-build .#checks.x86_64-linux.package-gui-install-test-ubuntu-22-04 Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-pytest-with-core Build done.
buildbot/nix-build .#checks.x86_64-linux.test-backups Build done.
buildbot/nix-build .#checks.x86_64-linux.flash Build done.
buildbot/nix-build .#checks.x86_64-linux.test-installation Build done.
buildbot/nix-eval Build done.
buildbot/nix-build .#checks.x86_64-linux.package-pending-reviews Build done.
buildbot/nix-build .#checks.x86_64-linux.package-module-schema Build done.
buildbot/nix-build .#checks.x86_64-linux.postgresql Build done.
buildbot/nix-build .#checks.x86_64-linux.nixos-flash-installer Build done.
buildbot/nix-build .#checks.x86_64-linux.nixos-iso-installer Build done.
buildbot/nix-build .#checks.x86_64-linux.secrets Build done.
buildbot/nix-build .#checks.x86_64-linux.zt-tcp-relay Build done.
buildbot/nix-build .#checks.x86_64-linux.wayland-proxy-virtwl Build done.
buildbot/nix-build .#checks.x86_64-linux.package-iso-installer Build done.
buildbot/nix-build .#checks.x86_64-linux.template-minimal Build done.
buildbot/nix-build .#checks.x86_64-linux.devShell-clan-app Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-pytest-without-core Build done.
checks / checks-impure (pull_request) Successful in 2m11s
128 lines
3.9 KiB
Python
128 lines
3.9 KiB
Python
# !/usr/bin/env python3
|
|
import argparse
|
|
|
|
from .create import register_create_parser
|
|
from .delete import register_delete_parser
|
|
from .hardware import register_hw_generate
|
|
from .install import register_install_parser
|
|
from .list import register_list_parser
|
|
from .show import register_show_parser
|
|
from .update import register_update_parser
|
|
|
|
|
|
# takes a (sub)parser and configures it
|
|
def register_parser(parser: argparse.ArgumentParser) -> None:
|
|
subparser = parser.add_subparsers(
|
|
title="command",
|
|
description="the command to run",
|
|
help="the command to run",
|
|
required=True,
|
|
)
|
|
|
|
update_parser = subparser.add_parser(
|
|
"update",
|
|
help="Update a machine",
|
|
epilog=(
|
|
"""
|
|
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 attempt to update every configured machine.
|
|
To exclude machines being updated `clan.deployment.requireExplicitUpdate = true;`
|
|
can be set in the machine config.
|
|
|
|
For more detailed information, visit: https://docs.clan.lol/getting-started/deploy
|
|
"""
|
|
),
|
|
formatter_class=argparse.RawTextHelpFormatter,
|
|
)
|
|
register_update_parser(update_parser)
|
|
|
|
create_parser = subparser.add_parser("create", help="Create a machine")
|
|
register_create_parser(create_parser)
|
|
|
|
delete_parser = subparser.add_parser("delete", help="Delete a machine")
|
|
register_delete_parser(delete_parser)
|
|
|
|
list_parser = subparser.add_parser(
|
|
"list",
|
|
help="List machines",
|
|
epilog=(
|
|
"""
|
|
This subcommand lists all machines managed by this clan.
|
|
|
|
Examples:
|
|
|
|
$ clan machines list
|
|
Lists all the machines and their descriptions.
|
|
"""
|
|
),
|
|
formatter_class=argparse.RawTextHelpFormatter,
|
|
)
|
|
register_list_parser(list_parser)
|
|
|
|
generate_hw_parser = subparser.add_parser(
|
|
"hw-generate",
|
|
help="Generate hardware specifics for a machine",
|
|
description="""
|
|
Generates hardware specifics for a machine. Such as the host platform, available kernel modules, etc.
|
|
|
|
The target must be a Linux based system reachable via SSH.
|
|
""",
|
|
epilog=(
|
|
"""
|
|
Examples:
|
|
|
|
$ clan machines hw-generate [MACHINE] [TARGET_HOST]
|
|
Will generate hardware specifics for the the specified `[TARGET_HOST]` and place the result in hardware.nix for the given machine `[MACHINE]`.
|
|
|
|
For more detailed information, visit: https://docs.clan.lol/getting-started/configure/#machine-configuration
|
|
|
|
"""
|
|
),
|
|
)
|
|
register_hw_generate(generate_hw_parser)
|
|
|
|
show_parser = subparser.add_parser(
|
|
"show",
|
|
help="Show a machine",
|
|
epilog=(
|
|
"""
|
|
This subcommand shows the details of a machine managed by this clan like icon, description, etc
|
|
"""
|
|
),
|
|
)
|
|
register_show_parser(show_parser)
|
|
|
|
install_parser = subparser.add_parser(
|
|
"install",
|
|
help="Install a machine",
|
|
description="""
|
|
Install a configured machine over the network.
|
|
The target must be a Linux based system reachable via SSH.
|
|
Installing a machine means overwriting the target's disk.
|
|
""",
|
|
epilog=(
|
|
"""
|
|
This subcommand provides an interface to install machines managed by clan.
|
|
|
|
Examples:
|
|
|
|
$ clan machines install [MACHINE] [TARGET_HOST]
|
|
Will install the specified machine [MACHINE], to the specified [TARGET_HOST].
|
|
|
|
$ clan machines install [MACHINE] --json [JSON]
|
|
Will install the specified machine [MACHINE] to the host exposed by
|
|
the deployment information of the [JSON] deployment string.
|
|
|
|
For information on how to set up the installer see: https://docs.clan.lol/getting-started/installer/
|
|
For more detailed information, visit: https://docs.clan.lol/getting-started/deploy
|
|
"""
|
|
),
|
|
formatter_class=argparse.RawTextHelpFormatter,
|
|
)
|
|
register_install_parser(install_parser)
|