Getting help

Help menus

The --help flag can be used to view the help menu for a command, e.g., for fyn:

$ fyn --help

To view the help menu for a specific command, e.g., for fyn init:

$ fyn init --help

When using the --help flag, fyn displays a condensed help menu. To view a longer help menu for a command, use fyn help:

$ fyn help

To view the long help menu for a specific command, e.g., for fyn init:

$ fyn help init

When using the long help menu, fyn will attempt to use less or more to "page" the output so it is not all displayed at once. To exit the pager, press q.

Displaying verbose output

The -v flag can be used to display verbose output for a command, e.g., for fyn sync:

$ fyn sync -v

The -v flag can be repeated to increase verbosity, e.g.:

$ fyn sync -vv

Often, the verbose output will include additional information about why fyn is behaving in a certain way.

Viewing the version

When seeking help, it's important to determine the version of fyn that you're using — sometimes the problem is already solved in a newer version.

To check the installed version:

$ fyn self version

The following are also valid:

$ fyn --version      # Same output as `fyn self version`
$ fyn -V             # Will not include the build commit and date

Note

Before fyn 0.7.0, fyn version was used instead of fyn self version.

Troubleshooting issues

The reference documentation contains a troubleshooting guide for common issues.

Open an issue on GitHub

The issue tracker on GitHub is a good place to report bugs and request features. Make sure to search for similar issues first, as it is common for someone else to encounter the same problem.