Skip to content

hyfi.__click__

This module contains the command line interface for the hyfi package. It is implemented using the click package. You can run the CLI by executing the hyfi-run command.

cli

This is the auxiliary command line interface for Hyfi. The main command line interface is 'hyfi'.

It is used to help run HyFI applications. If no command is specified, it will compose a configuration and run it.

It is also used to copy configuration files to the destination directory and to install shell completion for Hyfi.

:param click.core.Context ctx: Click context.

Usage:

cli [OPTIONS] COMMAND [ARGS]...

Options:

  --version          Show the version and exit.
  -c, --config TEXT  Config group to compose and run
  -p, --print        Print the configuration instead of running it
  --help             Show this message and exit.

about

Print the about information for Hyfi.

Usage:

cli about [OPTIONS]

Options:

  --help  Show this message and exit.

cc

Copy all config files to the destination directory.

Usage:

cli cc [OPTIONS]

Options:

  --src_path TEXT   Source path to copy from  [default: hyfi/conf]
  --dst_path TEXT   Destination path to copy to  [default: ./tmp/conf]
  --exclude TEXT    Exclude files matching this pattern
  --skip_if_exists  Skip if destination exists
  --overwrite       Overwrite destination
  --dry_run         Dry run
  --verbose         Verbose output
  --help            Show this message and exit.

sc

Install or Uninstall shell completion for Hyfi.

Usage:

cli sc [OPTIONS]

Options:

  -u, --uninstall   Uninstall shell completion
  -s, --shell TEXT  Shell to install completion for  [default: zsh]
  --help            Show this message and exit.