mirror of
https://github.com/AstrBotDevs/AstrBot
synced 2026-07-15 17:30:13 +08:00
97f0fd3de3
- Updated the VitePress configuration to include links to CLI commands in both English and Chinese. - Enhanced the AstrBot deployment documentation with instructions for installing it as a system service. - Created comprehensive CLI commands documentation covering initialization, service management, configuration, and plugin management. - Added tests for CLI command aliases and service functionalities to ensure proper command registration and behavior. - Implemented service log management features, including enabling application logging and controlling log visibility.
78 lines
2.3 KiB
Python
78 lines
2.3 KiB
Python
"""AstrBot CLI entry point"""
|
|
|
|
import sys
|
|
|
|
import click
|
|
|
|
from . import __version__
|
|
from .commands import config, init, password, plugin, run, service
|
|
|
|
logo_tmpl = r"""
|
|
___ _______.___________..______ .______ ______ .___________.
|
|
/ \ / | || _ \ | _ \ / __ \ | |
|
|
/ ^ \ | (----`---| |----`| |_) | | |_) | | | | | `---| |----`
|
|
/ /_\ \ \ \ | | | / | _ < | | | | | |
|
|
/ _____ \ .----) | | | | |\ \----.| |_) | | `--' | | |
|
|
/__/ \__\ |_______/ |__| | _| `._____||______/ \______/ |__|
|
|
"""
|
|
|
|
|
|
class AstrBotCLIGroup(click.Group):
|
|
COMMAND_ALIASES = {
|
|
"conf": "config",
|
|
"plug": "plugin",
|
|
}
|
|
|
|
def get_command(self, ctx: click.Context, cmd_name: str) -> click.Command | None:
|
|
command = super().get_command(ctx, cmd_name)
|
|
if command is not None:
|
|
return command
|
|
alias_target = self.COMMAND_ALIASES.get(cmd_name)
|
|
if alias_target is None:
|
|
return None
|
|
return super().get_command(ctx, alias_target)
|
|
|
|
|
|
@click.group(cls=AstrBotCLIGroup)
|
|
@click.version_option(__version__, prog_name="AstrBot")
|
|
def cli() -> None:
|
|
"""The AstrBot CLI"""
|
|
click.echo(logo_tmpl)
|
|
click.echo("Welcome to AstrBot CLI!")
|
|
click.echo(f"AstrBot CLI version: {__version__}")
|
|
|
|
|
|
@click.command()
|
|
@click.argument("command_name", required=False, type=str)
|
|
def help(command_name: str | None) -> None:
|
|
"""Display help information for commands
|
|
|
|
If COMMAND_NAME is provided, display detailed help for that command.
|
|
Otherwise, display general help information.
|
|
"""
|
|
ctx = click.get_current_context()
|
|
if command_name:
|
|
# Find the specified command
|
|
command = cli.get_command(ctx, command_name)
|
|
if command:
|
|
# Display help for the specific command
|
|
click.echo(command.get_help(ctx))
|
|
else:
|
|
click.echo(f"Unknown command: {command_name}")
|
|
sys.exit(1)
|
|
else:
|
|
# Display general help information
|
|
click.echo(cli.get_help(ctx))
|
|
|
|
|
|
cli.add_command(init)
|
|
cli.add_command(run)
|
|
cli.add_command(help)
|
|
cli.add_command(plugin)
|
|
cli.add_command(config)
|
|
cli.add_command(password)
|
|
cli.add_command(service)
|
|
|
|
if __name__ == "__main__":
|
|
cli()
|