[Entirety of Espanso help text] #espanso

help.txt

espanso 2.2.1
Federico Terzi
A Privacy-first, Cross-platform Text Expander

USAGE:
    espanso [FLAGS] [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -v               Sets the level of verbosity
    -V, --version    Prints version information

OPTIONS:


SUBCOMMANDS:
    cmd           Send a command to the espanso daemon.
    edit          Shortcut to open the default text editor to edit config files
    env-path      Add or remove the 'espanso' command from the PATH
    help          Prints this message or the help of the given subcommand(s)
    install       Install a package
    log           Print the daemon logs.
    match         List and execute matches from the CLI
    migrate       Automatically migrate legacy config files to the new v2 format.
    package       package-management commands
    path          Prints all the espanso directory paths to easily locate configuration and matches.
    restart       Restart the espanso service
    service       A collection of commands to manage the Espanso service (for example, enabling auto-start on system
                  boot).
    start         Start espanso as a service
    status        Check if the espanso daemon is running or not.
    stop          Stop espanso service
    uninstall     Remove a package
    workaround    A collection of workarounds to solve some common problems.


Subcommand: cmd
===
espanso-cmd 
Send a command to the espanso daemon.

USAGE:
    espanso cmd [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    disable    Disable expansions.
    enable     Enable expansions.
    help       Prints this message or the help of the given subcommand(s)
    search     Open the Espanso's search bar.
    toggle     Enable/Disable expansions.


Subcommand: disable
=======
espanso-cmd-disable 
Disable expansions.

USAGE:
    espanso cmd disable

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: enable
======
espanso-cmd-enable 
Enable expansions.

USAGE:
    espanso cmd enable

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: help
====
Error: Failed to get help for espanso cmd help. Make sure the command exists and supports --help option.

Subcommand: search
======
espanso-cmd-search 
Open the Espanso's search bar.

USAGE:
    espanso cmd search

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: toggle
======
espanso-cmd-toggle 
Enable/Disable expansions.

USAGE:
    espanso cmd toggle

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: edit
====
espanso-edit 
Shortcut to open the default text editor to edit config files

USAGE:
    espanso edit [target_file]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

ARGS:
    <target_file>    Defaults to "match/base.yml", it contains the relative path of the file you want to edit, 
                     such as 'config/default.yml' or 'match/base.yml'. 
                     For convenience, you can also specify the name directly and Espanso will figure out the path. 
                     For example, specifying 'email' is equivalent to 'match/email.yml'.


Subcommand: env-path
========
espanso-env-path 
Add or remove the 'espanso' command from the PATH

USAGE:
    espanso env-path [FLAGS] [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
        --prompt     macOS only:Prompt for permissions if the operation requires elevated privileges.
    -V, --version    Prints version information

SUBCOMMANDS:
    help          Prints this message or the help of the given subcommand(s)
    register      Add 'espanso' command to PATH
    unregister    Remove 'espanso' command from PATH


Subcommand: help
====
Error: Failed to get help for espanso env-path help. Make sure the command exists and supports --help option.

Subcommand: register
========
espanso-env-path-register 
Add 'espanso' command to PATH

USAGE:
    espanso env-path register

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: unregister
==========
espanso-env-path-unregister 
Remove 'espanso' command from PATH

USAGE:
    espanso env-path unregister

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: help
====
Error: Failed to get help for espanso help. Make sure the command exists and supports --help option.

Subcommand: install
=======
espanso-install 
Install a package

USAGE:
    espanso install [FLAGS] [OPTIONS] [package_name]

FLAGS:
    -e, --external          Allow installing packages from non-verified repositories.
        --force             Overwrite the package if already installed
    -h, --help              Prints help information
        --refresh-index     Request a fresh copy of the Espanso Hub package index instead of using the cached version.
        --use-native-git    If specified, espanso will use the 'git' command instead of trying direct methods.

OPTIONS:
        --git <git>                  Git repository from which espanso should install the package.
        --git-branch <git-branch>    Force espanso to search for the package on a specific git branch
        --version <version>          Force a particular version to be installed instead of the latest available.

ARGS:
    <package_name>    Package name


Subcommand: log
===
espanso-log 
Print the daemon logs.

USAGE:
    espanso log

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: match
=====
espanso-match 
List and execute matches from the CLI

USAGE:
    espanso match [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    exec    Triggers the expansion of a match
    help    Prints this message or the help of the given subcommand(s)
    list    Print matches to standard output


Subcommand: exec
====
espanso-match-exec 
Triggers the expansion of a match

USAGE:
    espanso match exec [OPTIONS]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
        --arg <arg>...         Specify also an argument for the expansion, following the --arg 'name=value' format. You
                               can specify multiple ones.
    -t, --trigger <trigger>    The trigger of the match to be expanded


Subcommand: help
====
Error: Failed to get help for espanso match help. Make sure the command exists and supports --help option.

Subcommand: list
====
espanso-match-list 
Print matches to standard output

USAGE:
    espanso match list [FLAGS] [OPTIONS]

FLAGS:
    -h, --help                 Prints help information
    -j, --json                 Output matches to the JSON format
    -t, --only-triggers        Print only triggers without replacement
    -n, --preserve-newlines    Preserve newlines when printing replacements. Does nothing when using JSON format.
    -V, --version              Prints version information

OPTIONS:
        --class <class>    Only return matches that would be active with the given class. This is relevant if you want
                           to list matches only active inside an app-specific config.
        --exec <exec>      Only return matches that would be active with the given exec. This is relevant if you want to
                           list matches only active inside an app-specific config.
        --title <title>    Only return matches that would be active with the given title. This is relevant if you want
                           to list matches only active inside an app-specific config.


Subcommand: migrate
=======
Migrate the configuration without asking for confirmation


Subcommand: package
=======
espanso-package 
package-management commands

USAGE:
    espanso package [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    help         Prints this message or the help of the given subcommand(s)
    install      Install a package
    list         List all installed packages
    uninstall    Remove a package
    update       Update a package. If 'all' is passed as package name, attempts to update all packages.


Subcommand: help
====
Error: Failed to get help for espanso package help. Make sure the command exists and supports --help option.

Subcommand: install
=======
espanso-package-install 
Install a package

USAGE:
    espanso package install [FLAGS] [OPTIONS] [package_name]

FLAGS:
    -e, --external          Allow installing packages from non-verified repositories.
        --force             Overwrite the package if already installed
    -h, --help              Prints help information
        --refresh-index     Request a fresh copy of the Espanso Hub package index instead of using the cached version.
        --use-native-git    If specified, espanso will use the 'git' command instead of trying direct methods.

OPTIONS:
        --git <git>                  Git repository from which espanso should install the package.
        --git-branch <git-branch>    Force espanso to search for the package on a specific git branch
        --version <version>          Force a particular version to be installed instead of the latest available.

ARGS:
    <package_name>    Package name


Subcommand: list
====
espanso-package-list 
List all installed packages

USAGE:
    espanso package list

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: uninstall
=========
espanso-package-uninstall 
Remove a package

USAGE:
    espanso package uninstall [package_name]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

ARGS:
    <package_name>    Package name


Subcommand: update
======
espanso-package-update 
Update a package. If 'all' is passed as package name, attempts to update all packages.

USAGE:
    espanso package update [package_name]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

ARGS:
    <package_name>    Package name


Subcommand: path
====
espanso-path 
Prints all the espanso directory paths to easily locate configuration and matches.

USAGE:
    espanso path [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    base        Print the default match file path.
    config      Print the current config folder path.
    default     Print the default configuration file path.
    help        Prints this message or the help of the given subcommand(s)
    packages    Print the current packages folder path.
    runtime     Print the current runtime folder path.


Subcommand: base
====
espanso-path-base 
Print the default match file path.

USAGE:
    espanso path base

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: config
======
espanso-path-config 
Print the current config folder path.

USAGE:
    espanso path config

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: default
=======
espanso-path-default 
Print the default configuration file path.

USAGE:
    espanso path default

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: help
====
Error: Failed to get help for espanso path help. Make sure the command exists and supports --help option.

Subcommand: packages
========
espanso-path-packages 
Print the current packages folder path.

USAGE:
    espanso path packages

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: runtime
=======
espanso-path-runtime 
Print the current runtime folder path.

USAGE:
    espanso path runtime

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: restart
=======
espanso-restart 
Restart the espanso service

USAGE:
    espanso restart [FLAGS]

FLAGS:
    -h, --help         Prints help information
        --unmanaged    Run espanso as an unmanaged service (avoid system manager)
    -V, --version      Prints version information


Subcommand: service
=======
espanso-service 
A collection of commands to manage the Espanso service (for example, enabling auto-start on system boot).

USAGE:
    espanso service [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    check         Check if espanso is registered as a system service
    help          Prints this message or the help of the given subcommand(s)
    register      Register espanso as a system service
    restart       Restart the espanso service
    start         Start espanso as a service
    status        Check if the espanso daemon is running or not.
    stop          Stop espanso service
    unregister    Unregister espanso from system services


Subcommand: check
=====
espanso-service-check 
Check if espanso is registered as a system service

USAGE:
    espanso service check

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: help
====
Error: Failed to get help for espanso service help. Make sure the command exists and supports --help option.

Subcommand: register
========
espanso-service-register 
Register espanso as a system service

USAGE:
    espanso service register

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: restart
=======
espanso-service-restart 
Restart the espanso service

USAGE:
    espanso service restart [FLAGS]

FLAGS:
    -h, --help         Prints help information
        --unmanaged    Run espanso as an unmanaged service (avoid system manager)
    -V, --version      Prints version information


Subcommand: start
=====
espanso-service-start 
Start espanso as a service

USAGE:
    espanso service start [FLAGS]

FLAGS:
    -h, --help         Prints help information
        --unmanaged    Run espanso as an unmanaged service (avoid system manager)
    -V, --version      Prints version information


Subcommand: status
======
espanso-service-status 
Check if the espanso daemon is running or not.

USAGE:
    espanso service status

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: stop
====
espanso-service-stop 
Stop espanso service

USAGE:
    espanso service stop

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: unregister
==========
espanso-service-unregister 
Unregister espanso from system services

USAGE:
    espanso service unregister

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: boot).
======
Error: Failed to get help for espanso boot).. Make sure the command exists and supports --help option.

Subcommand: start
=====
espanso-start 
Start espanso as a service

USAGE:
    espanso start [FLAGS]

FLAGS:
    -h, --help         Prints help information
        --unmanaged    Run espanso as an unmanaged service (avoid system manager)
    -V, --version      Prints version information


Subcommand: status
======
espanso-status 
Check if the espanso daemon is running or not.

USAGE:
    espanso status

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: stop
====
espanso-stop 
Stop espanso service

USAGE:
    espanso stop

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information


Subcommand: uninstall
=========
espanso-uninstall 
Remove a package

USAGE:
    espanso uninstall [package_name]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

ARGS:
    <package_name>    Package name


Subcommand: workaround
==========
espanso-workaround 
A collection of workarounds to solve some common problems.

USAGE:
    espanso workaround [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    help            Prints this message or the help of the given subcommand(s)
    secure-input    Attempt to disable secure input by automating the common steps.


Subcommand: help
====
Error: Failed to get help for espanso workaround help. Make sure the command exists and supports --help option.

Subcommand: secure-input
============
espanso-workaround-secure-input 
Attempt to disable secure input by automating the common steps.

USAGE:
    espanso workaround secure-input

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information