# Commands

The commands are present in alphabetical order and organized by the domain followed by the action. Most of the information
can be found through the use of the `--help` flag. This page provides information on nuances and edge cases that might
not have fit in the CLI descriptions themselves. 

```
Usage: main.py [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  config-edit          prompts user to update settings values
  config-init          walks the user through the first time configuration
  config-secrets-edit  prompts user to update secret values in keyring
  config-secrets-show  displays the sensitive variables from the keyring
  config-show          displays the settings to the console
  digest-by-ids        generate EPUB from comma-separated Wallabag IDs
  digest-cover-create  procedurally generate a cover image for your digest
  digest-recent        generate EPUB from recent Wallabag articles
  donate               prints link to Glass Hound Computing's donation page
  entry-add            add an entry to your Wallabag instance
  system-fonts-show    displays installed system fonts
```

## config-edit
prompts user to update settings values

An in depth guide about the configuration can be found in the [settings](https://wiki.freecomputer.club/books/wallypub-user-guide/page/settings) section. 

## config-init
walks the user through the first time configuration

The first time configuration assumes some defaults, opting to only setup the
requirements to generate a digest. Additional settings can be adjusted
through the config-edit command.

If the default font is not installed, wallypub will install that in your system fonts.


## config-secrets-edit
prompts user to update secret values in keyring

More details about the secrets can be found in the [secrets]() section.

## config-secrets-show
displays the sensitive variables from the keyring

## config-show
displays the settings to the console

## digest-by-ids
generate EPUB from comma-separated Wallabag IDs

The IDs should correlate with Wallabag entries.
When viewing from the web, the entry ID can be found in the URL
In https://app.wallabag.it/view/32247628 the ID would be 32247628

## digest-cover-create
procedurally generate a cover image for your digest

digest_cover_create exists mostly to have a means of independently test that
image generation works on the machine. It is also useful for testing new fonts to see how they look on the page. 

Wallypub will automatically generate a new cover if the configured filename in the cover_file setting matches
the default name of "cover.jpg", this remains true even if you configure another directory as the location
for the static files. Recommendation is to call the file something "custom_cover.ext" or "name_of_digest.ext". 

## digest-recent
generate EPUB from recent Wallabag articles

## donate
prints link to Glass Hound Computing's donation page

buymeacoffee.com/glasshoundcomputing

## entry-add

```text

Usage: main.py entry-add [OPTIONS] URL

  add an entry to your Wallabag instance

  The `--tags` flag for `entry-add` needs to be wrapped in a string `""` to 
  get comma separation if you intend on using spaces
  within your tags. 
  
Options:
  --tags TEXT  comma separated string
  --help       Show this message and exit.


```




## system-fonts-show

```text
Usage: main.py system-fonts-show [OPTIONS]

  displays installed system fonts

Options:
  --scroll       allows you to scroll through system fonts q to quit
  --search TEXT  fuzzy search for font names
  --help         Show this message and exit.

```