# aba [![built with nix](https://builtwithnix.org/badge.svg)](https://builtwithnix.org) [![REUSE status][reuse-api-badge]][reuse-api-info] [![Static Badge][shields-io-license]](LICENSES/ISC.txt) [![Dynamic TOML Badge][version-badge]][refs] [![builds.sr.ht status](https://builds.sr.ht/~onemoresuza/aba.svg)](https://builds.sr.ht/~onemoresuza/aba?) [![Crates.io](https://img.shields.io/crates/v/aba?logo=rust)](https://crates.io/crates/aba/versions) ![Crates.io](https://img.shields.io/crates/d/aba?logo=Rust) [![dependency status][deps-rs-svg]][deps-rs-page] [reuse-api-badge]: [reuse-api-info]: [shields-io-license]: [deps-rs-svg]: [deps-rs-page]: [version-badge]: > **Address Book for [Aerc][aerc]** # Contributing This project has a [mailing list][mailing-list] and a [tracker][tracker], which is for **confirmed** bugs and feature requests. [mailing-list]: [tracker]: # Changelog The changelog may be found [here][changelog]. [changelog]: # Installing [![Packaging status](https://repology.org/badge/vertical-allrepos/aba.svg)](https://repology.org/project/aba/versions) ## Nix `aba` is packaged on the [unstable channel][nixpkgs-unstable]. ```bash nix-env -iA nixos.aba # or nixpkgs.aba if on a non NixOS system ``` [nixpkgs-unstable]: ## crates.io `aba` is published on [crates.io][crates-io]. ```bash cargo install aba ``` [crates-io]: ## Pre-built Binary Beginning on [0.4.0][040-version], `aba` provides a pre-built binary for `x86_64-linux` and a checksum for it. They can be download [here][refs]. [040-version]: ## Manual Install from Manual Build Follow the [build instructions](#manual-build), then run: ```bash sudo just install ``` To not install at the default location, `/usr/local`, just set the `PREFIX variable`: ```bash just PREFIX="${HOME}/.local" install # now there's no need for root ``` # Building ## Nix Run: ```bash nix build . ``` ## Manual Build Install the following dependencies: 1. [just][just]; 1. [scdoc][scdoc]; and 1. [Rust][rust]. Then run: ```bash just ``` # Packaging ## Binary-based Distros Pre-built binaries are available at every new [tag][refs]. ## Source-based Distros To build `aba` from source be sure to have the following dependencies available: 1. [just][just] 1. [Rust][rust] ## Manpages To compile the manpages, [scdoc][scdoc] is needed. A [just][just] recipe is available for both compiling ([doc][doc-recipe]) and Installing and compiling ([install-doc][install-doc-recipe]). [doc-recipe]: [install-doc-recipe]: # aerc integration ## Address Completion Add the following to your **aerc.conf**: ```ini address-book-cmd=aba ls "%s" ``` ## Parsing Addresses from an Email Add the following to your **binds.conf**: ```ini [view] aa = :pipe -m aba parse --all ``` The option `--all` may be changed depending on what one wants, that is, to `--from`, `--cc` or `--to`. # Related Projects - [aercbook][aercbook], by [renerocksai][renerocksai]: a more minimalistic address book for [aerc][aerc] written in `Zig` whose functionality `aba` is **blatantly** based upon. - [aerc], by [sircmpwn][sircmpwn], maintained by [rjarry][rjarry]: `aba` is an address book for it, isn't? ;) [aerc]: [aercbook]: [just]: [refs]: [renerocksai]: [rjarry]: [rust]: [scdoc]: [sircmpwn]: