Anzeiger

A small, plugin-based TUI application.

Preamble

At the current stage, this project is just me having a blast fiddling around with @opentui/core. Call it a proof-of-concept project.

Anzeiger lives from it's plugins, which provide the application's actual content. I intend it to make it really simple to create plugins.

But here's the thing: Said (third-party) plugins are being loaded during runtime. There's no security checks at all.

"Why should I run this on my machine?", you may find yourself asking. Well, here's the thing: You probably shouldn't.

Anzeiger itself is not malicious and will never be. But it attempts to load any plugin you specify in plugins.json. It's impossible for me to prevent malicious code to be executed inside third-party plugins!

This may change in the future, or it may not. We'll see.

Getting started

Installing and running Anzeiger is pretty straightforward - in case you've installed Bun already. If not, you may want to give it a try. (Spoiler: It's awesome!)

Install & Run

# create directory (optional, but recommended to keep things clean)
mkdir anzeiger && cd "$_"

# install Anzeiger
bun install anzeiger

# run Anzeiger
bunx anzeiger

Configuration

Anzeiger reads (some of) it's configuration from environment variables. An easy way to set those is to create a .env file in the directory you've installed Anzeiger in.

Any future plugins might read their configuration differently. Anzeiger leaves configurations up to the plugins.

After changing the configuration you need to restart Anzeiger for the changes to take effect!

It's still empty

Yep, you'll need to install plugins. See further below.

Plugins

I'm currently working on a few (example) plugins for Anzeiger.

Adding a plugin consists of two steps:

1. Install the Plugin

# replace @anzeiger/now with your plugin name
bun install @anzeiger/now

2. Add Plugin to plugins.json

In case you haven't ran Anzeiger, yet, the plugins.json probably does not exist either. Either run bunx anzeiger, so that it gets auto-created, or create it yourself.

The plugins.json is the place for managing installed plugins. For now it's just a simple array of package names:

[
    "@anzeiger/now"
]

Plugins are loaded in order. This also determines the order of the plugins in Anzeiger's side menu.

Developing Plugins

coming soon...

Customization

There's no much customization built-in, yet. But we've got themes!

Available themes

Select your preferred theme by setting ANZEIGER_THEME in the .env accordingly.

If the environment variable is not set or contains invalid values, the application will fall back to fallout.

Supported themes are:

fallout

idk

acai

ultraviolet

For Developers

Feel free to customize this any way you want to, you've got the source code now. I'll eventually open source it.