# 🔑 Mimosa [](https://github.com/pimalaya/mimosa/releases/latest) []("https://repology.org/project/mimosa/versions) [](https://matrix.to/#/#pimalaya:matrix.org) [](https://fosstodon.org/@pimalaya)
CLI to manage passwords
## Table of contents
- [Features](#features)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [FAQ](#faq)
- [Social](#social)
- [Sponsoring](#sponsoring)
## Features
- Simple **CRUD** operations for passwords
- Multiple **keyring** backends via cargo features:
- D-Bus Secret Service on Linux (requires `dbus-secret-service` feature)
- Z-Bus Secret Service on Linux (requires `zbus-secret-service` feature)
- Keyutils on Linux (requires `keyutils` feature)
- Apple Keychain on macOS (requires `apple-keychain` feature)
- Windows Credential Manager (requires `windows-credential-manager` feature)
- **TOML** configuration
- **JSON** output with `--json`
*Mimosa CLI is written in [Rust](https://www.rust-lang.org/), and relies on [cargo features](https://doc.rust-lang.org/cargo/reference/features.html) to enable or disable functionalities. Default features can be found in the `features` section of the [`Cargo.toml`](https://github.com/pimalaya/mimosa/blob/master/Cargo.toml#L18), or on [docs.rs](https://docs.rs/crate/mimosa/latest/features).*
## Installation
### Pre-built binary
Mimosa CLI can be installed with the installer:
*As root:*
```
curl -sSL https://raw.githubusercontent.com/pimalaya/mimosa/master/install.sh | sudo sh
```
*As a regular user:*
```
curl -sSL https://raw.githubusercontent.com/pimalaya/mimosa/master/install.sh | PREFIX=~/.local sh
```
These commands install the latest binary from the GitHub [releases](https://github.com/pimalaya/mimosa/releases) section.
### Cargo
Mimosa CLI can be installed with [cargo](https://doc.rust-lang.org/cargo/):
```
cargo install mimosa
```
You can also use the git repository for a more up-to-date (but less stable) version:
```
cargo install --locked --git https://github.com/pimalaya/mimosa.git
```
### Nix
Mimosa CLI can be installed with [Nix](https://serokell.io/blog/what-is-nix):
```
nix-env -i mimosa
```
You can also use the git repository for a more up-to-date (but less stable) version:
```
nix-env -if https://github.com/pimalaya/mimosa/archive/master.tar.gz
```
If you have the [Flakes](https://nixos.wiki/wiki/Flakes) feature enabled:
```
nix profile install mimosa
```
*You can also run Mimosa directly without installing it:*
```
nix run mimosa
```
## Configuration
The wizard is not yet available (it should come soon), meanwhile you can manually edit your own configuration from scratch:
- Copy the content of the documented [`./config.sample.toml`](./config.sample.toml)
- Paste it into a new file `~/.config/mimosa/config.toml`
- Edit, then comment or uncomment the options you want
## Usage
### Write a password
You can either give the password as an argument, give a path of a valid file containing your password, or using Unix pipes or redirection:
```
$ mimosa password write ***
$ mimosa password write /path/to/***
$ mimosa password write < /path/to/***
$ echo *** | mimosa password write
Password successfully written to keyring
```
### Read a password
```
$ mimosa password read
***
```
With the `--json` argument:
```
$ mimosa password read --json
{"password":"***"}
```
### Remove a password
```
$ mimosa password remove
Password successfully removed from example
```
## FAQ
### How to debug Mimosa CLI?
The simplest way is to use `--debug` and/or `--trace` arguments.
The advanced way is based on environment variables:
- `RUST_LOG=<level>`: determines the log level filter, can be one of `off`, `error`, `warn`, `info`, `debug` and `trace`.
- `RUST_BACKTRACE=1`: enables the full error backtrace, which include source lines where the error originated from.
Logs are written to the `stderr`, which means that you can redirect them easily to a file:
```
mimosa password read --debug 2>/tmp/mimosa.log
```
## Social
- Chat on [Matrix](https://matrix.to/#/#pimalaya:matrix.org)
- News on [Mastodon](https://fosstodon.org/@pimalaya) or [RSS](https://fosstodon.org/@pimalaya.rss)
- Mail at [pimalaya.org@posteo.net](mailto:pimalaya.org@posteo.net)
## Sponsoring
[](https://nlnet.nl/)
Special thanks to the [NLnet foundation](https://nlnet.nl/) and the [European Commission](https://www.ngi.eu/) that have been financially supporting the project for years:
- 2022: [NGI Assure](https://nlnet.nl/project/Himalaya/)
- 2023: [NGI Zero Entrust](https://nlnet.nl/project/Pimalaya/)
- 2024: [NGI Zero Core](https://nlnet.nl/project/Pimalaya-PIM/) *(still ongoing in 2026)*
If you appreciate the project, feel free to donate using one of the following providers:
[](https://github.com/sponsors/soywod)
[](https://ko-fi.com/soywod)
[](https://www.buymeacoffee.com/soywod)
[](https://liberapay.com/soywod)
[](https://thanks.dev/soywod)
[](https://www.paypal.com/paypalme/soywod)