Hullcaster

Hullcaster is a terminal-based podcast manager, built in Rust. It provides a terminal UI (i.e., an ncurses-like interface) to allow users to subscribe to podcast feeds, and sync feeds to check for new episodes. Episodes may be downloaded locally, played with an external media player, and marked as played/unplayed. Key bindings and other options are configurable via a config file.

Note

This is a fork of shellcaster, which is no longer maintained. Currently, I am planning to implement the features stated below, while learning rust at the same time.

Planned changes

• [x] Option to avoid marking as read when playing
• [x] Syncing with the gpodder API
• [x] Add playing queue
• [ ] Internal Player using rodio
• [x] Show key bindings in a bar on the bottom
• [ ] Migrate to ratatui or Cursive
• [x] Add option to sync automatically on start, enabled by default
• [ ] Add periodic synchronization

TODO

• [x] Syncing with gpodder episode actions API (rudimentary, tested with opodsync)
• [x] Fix performance of mark-all as read
• [x] Fix bug deleting file
• [x] Show the podcast description only when a podcast is selected
• [x] Fix syncing podcasts, sometimes gets stuck (it seems timeout not working)
• [x] Support downloading subscriptions from gpodder
• [x] Support uploading subscriptions to gpodder
• [x] If gpodder is on, update actions right after syncing podcasts
• [x] Prevent screen flickering while syncing podcasts
• [x] Prevent screen flickering at the end of lists
• [x] Fix vertical screens
• [x] Clear details panel when nothing is selected
• [x] Make queue persistent
• [x] Fix crash when playing from queue
• [ ] Create lock file to prevent several instances of hullcaster
• [ ] Add option to play next from queue automatically, makes sense only after internal player is implemented
• [ ] Add history of episode actions. It seems that AntennaPod does not do this.
• [x] Avoid repeated elements in queue
• [x] Fix bug where queue actions are not persistent, hard to reproduce
• [ ] Fix gpodder test, it should use local files or local server
• [x] Add panel for unplayed episodes across podcasts
• [x] Fix bug in two-column state, going to/from queue from/to episode/unplayed panel does not work
• [x] Unplayed items not sorted correctly
• [ ] Errors appear sporadically synchronizing podcasts with gpodder
• [x] Unplayed items not updated after sync
• [x] ~ folder created when creating logs

Installing hullcaster

Archlinux

The package is available in the AUR hullcaster-git.

NixOS / Nix

With flakes enabled, run:

nix run github:gilcu3/hullcaster

On Linux distributions

Currently, the only option is to build from source.

First, ensure you have installed the necessary dependencies: rust, gcc, pkgconf, sqlite (package names in Archlinux).

Next, you can clone the Github repo and compile it yourself:

git clone https://github.com/gilcu3/hullcaster.git
cd hullcaster
cargo build --release  # add or remove any features with --features

# no root permissions
cp target/release/hullcaster ~/.local/bin

Running hullcaster

In your terminal, run:

hullcaster

Note that if you installed hullcaster to a different location, ensure that this location has been added to your $PATH:

export PATH="/path/to/add:$PATH"

Importing/exporting podcasts

Hullcaster supports importing OPML files from other podcast managers. If you can export to an OPML file from another podcast manager, you can import this file with:

hullcaster import -f /path/to/OPML/file.opml

If the -r flag is added to this command, it will overwrite any existing podcasts that are currently stored in hullcaster. You can also pipe in data to hullcaster import from stdin by not specifying the -f <file>.

You can export an OPML file from hullcaster with the following command:

hullcaster export -f /path/to/output/file.opml

You can also export to stdout by not specifying the -f <file>; for example, this command is equivalent:

hullcaster export > /path/to/output/file.opml

Configuring hullcaster

If you want to change configuration settings, the sample config.toml file can be copied from here. Download it, edit it to your fancy, and place it in the following location:

# on Linux
mkdir -p ~/.config/hullcaster
cp config.toml ~/.config/hullcaster/

Or you can put config.toml in a place of your choosing, and specify the location at runtime:

hullcaster -c /path/to/config.toml

The sample file above provides comments that should walk you through all the available options. If any field does not appear in the config file, it will be filled in with the default value specified in those comments.

Default key bindings

Note: Actions can be mapped to more than one key (e.g., "Enter" and "p" both play an episode), but a single key may not do more than one action (e.g., you can't set "d" to both download and delete episodes).

Customizable colors

You can set the colors in the app with either built-in terminal colors or (provided your terminal supports it) customizable colors as well. See the "colors" section in the config.toml for details about how to specify these colors!

Syncing without the UI

Some users may wish to sync their podcasts automatically on a regular basis, e.g., every morning. The hullcaster sync subcommand can be used to do this without opening up the UI, and does a full sync of all podcasts in the database. This could be used to set up a cron job or systemd timer, for example. Please refer to the relevant documentation for these systems for setting it up on the schedule of your choice.