Skip to content

mirador

mirador is a CLI to watch mailbox changes made by the maintaner of himalaya.

Features:

  • Watches and executes actions on mailbox changes
  • Interactive configuration via wizard (requires wizard feature)
  • Supported events: on message added.
  • Supported actions: send system notification, execute shell command.
  • Supports IMAP mailboxes (requires imap feature)
  • Supports Maildir folders (requires maildir feature)
  • Supports global system keyring to manage secrets (requires keyring feature)
  • Supports OAuth 2.0 (requires oauth2 feature)

Mirador CLI is written in Rust, and relies on cargo features to enable or disable functionalities. Default features can be found in the features section of the Cargo.toml.

Installation⚑

The v1.0.0 is currently being tested on the master branch, and is the preferred version to use. Previous versions (including GitHub beta releases and repositories published versions) are not recommended.

Cargo (git)⚑

Mirador CLI v1.0.0 can also be installed with cargo:

$ cargo install --frozen --force --git https://github.com/pimalaya/mirador.git

Pre-built binary⚑

Mirador CLI v1.0.0 can be installed with a pre-built binary. Find the latest pre-release GitHub workflow and look for the Artifacts section. You should find a pre-built binary matching your OS.

Configuration⚑

Just run mirador, the wizard will help you to configure your default account.

You can also manually edit your own configuration, from scratch:

  • Copy the content of the documented ./config.sample.toml
  • Paste it in a new file ~/.config/mirador/config.toml
  • Edit, then comment or uncomment the options you want

Usage⚑

References⚑