Home

An open-source, modular e-ink display platform. With a growing library of installable plugins, InkyPi lets you turn a Raspberry Pi and e-ink screen into a customizable dashboard for your favorite content.

Default plugins

A list of plugins that are installed by default, along with their source code, can be found here: https://github.com/fatihak/InkyPi/tree/main/src/plugins

Third party plugins

A community-maintained list of third-party plugins is available here: https://github.com/fatihak/InkyPi/wiki/3rd-Party-Plugins

Installing a plugin

Follow these steps to install a custom or third-party plugin.

• Install the plugin using the InkyPi CLI, providing the GitHub repository URL and the plugin ID:

inkypi plugin install <plugin_id> <git_repo_url>

• Follow any additional setup instructions provided in the plugin’s github repository README.

Uninstall a plugin

To uninstall a plugin, run:

inkypi plugin uninstall <plugin_id>

If the plugin is referenced in any playlists, you must remove those plugin instances manually after uninstalling.

List installed plugins

To list all installed plugins, run:

inkypi plugin list