aegis-cli 1.0.7

Show TOTPs from Aegis vault on CLI
aegis-cli-1.0.7 is not a library.

ci dependency status License: GPL v3 downloads

aegis-cli 1.0.7

Show TOTPs from Aegis vault on CLI

CLI app for showing TOTP codes from an Aegis vault file (like from the backup file from the Aegis Android app Aegis Authenticator). After aegis-rs.

Features

  • Decryption of the 256 bit AES-GCM encrypted vault 🔓
  • Fuzzy selection 🔍
  • TOTP display 🕒
  • Clears the screen when done
  • Time left indication ⏳
  • Clipboard support 📋
  • Optional JSON output to stdout 📜

Usage

Installation

The easiest way to install aegis-cli is by using cargo.

Cargo from crates.io

cargo install aegis-cli

Cargo from git

cargo install --git https://github.com/pepa65/aegis-cli

Static build (avoiding GLIBC incompatibilities)

git clone https://github.com/pepa65/aegis-cli
cd aegis-cli
rustup target add x86_64-unknown-linux-musl
export RUSTFLAGS='-C target-feature=+crt-static'
cargo build --release --target=x86_64-unknown-linux-musl

Install static single-binary

wget https://github.com/pepa65/aegis-cli/releases/download/1.0.7/aegis
sudo mv aegis /usr/local/bin
sudo chown root:root /usr/local/bin/aegis
sudo chmod +x /usr/local/bin/aegis

Launching Aegis-cli with an Aegis vault file

To start aegis-cli, simply pass the path to your backup file as an argument and enter the password when prompted. For example:

aegis aegis-backup-20230512-193110.json

? Insert Aegis Password › ********

Searching for an Entry

Fuzzy finding is supported for quickly locating entries. Type some letters of the entry's name to filter the list. Pressing Esc exits the app.

Displaying the OTP

After an entry is selected, the TOTP can be copied from the terminal or pasted through the integrated clipboard support. TOTPs are updated automatically upon expiration. Pressing Esc will go back to the Fuzzy selection screen.

Ways to unlock the Vault

To unlock the Aegis vault aegis-cli supports the following methods:

  1. Password prompt: If no password is provided, aegis-cli will prompt for a password.
  2. Password file: A file containing the password to unlock the Aegis vault:
  • Environment variable: AEGIS_PASSWORD_FILE
  • Argument: -p <PASSWORD_FILE> or --password-file <PASSWORD_FILE>
  • Example: aegis -p ~/.aegis.pw aegis-vault.json
  1. Password: The password can be passed as an argument or set as an environment variable:
  • Environment variable: AEGIS_PASSWORD
  • Argument: -P <PASSWORD> or --password <PASSWORD>
  • Example: aegis -P jkhglhkjhkjf aegis-vault.json

Extra flags

  • -n <NAME>... or --name <NAME>...: Pre-filter entries by entries NAME.
    • Example: aegis -n git dave aegis-vault.json
  • -i <ISSUER>... or --issuer <ISSUER>...: Pre-filter entries by entries ISSUER.
  • -j or --json: Output the (pre-filtered) TOTPs as JSON.

Help

aegis-cli 1.0.7 - Show TOTPs from Aegis vault on CLI
Usage: aegis [OPTIONS] <VAULT_FILE>
Arguments:
  <VAULT_FILE>  Path to Aegis vault file [env: AEGIS_VAULT_FILE=]

Options:
  -p, --password-file <PASSWORD_FILE>  Path to file with the Aegis vault password [env: AEGIS_PASSWORD_FILE=]
  -P, --password <PASSWORD>            PASSWORD to unlock Aegis vault [env: AEGIS_PASSWORD]
  -i, --issuer <ISSUER>...             Filter by ISSUER
  -n, --name <NAME>...                 Filter by NAME
  -j, --json                           Display (pre-filtered) entries in JSON on stdout
  -h, --help                           Print help
  -V, --version                        Print version

Project history

This project has been divided into a CLI binary (this repo) and a vault utility crate so that other projects can utilize the parsing and TOTP generation functionalities as well.

License

This project is licensed under the GNU General Public License v3.0. See the LICENSE file for details.