{"id":17059081,"url":"https://github.com/rjarry/aerc","last_synced_at":"2025-04-12T17:51:15.040Z","repository":{"id":39669378,"uuid":"427885640","full_name":"rjarry/aerc","owner":"rjarry","description":"Read-only mirror of https://git.sr.ht/~rjarry/aerc. This repositoriy does not accept pull requests. Please send contributions to https://lists.sr.ht/~rjarry/aerc-devel.","archived":false,"fork":false,"pushed_at":"2024-04-13T20:37:44.000Z","size":4910,"stargazers_count":70,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-14T09:57:17.241Z","etag":null,"topics":["email","tui"],"latest_commit_sha":null,"homepage":"https://git.sr.ht/~rjarry/aerc","language":"Go","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rjarry.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-14T09:24:31.000Z","updated_at":"2024-04-30T23:30:58.632Z","dependencies_parsed_at":"2023-11-12T12:34:06.393Z","dependency_job_id":"2d11db1b-6117-49cf-8b39-88ad994c3859","html_url":"https://github.com/rjarry/aerc","commit_stats":null,"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rjarry%2Faerc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rjarry%2Faerc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rjarry%2Faerc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rjarry%2Faerc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rjarry","download_url":"https://codeload.github.com/rjarry/aerc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248610409,"owners_count":21132920,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["email","tui"],"created_at":"2024-10-14T10:32:32.038Z","updated_at":"2025-04-12T17:51:15.033Z","avatar_url":"https://github.com/rjarry.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# aerc\n\n[![builds.sr.ht status](https://builds.sr.ht/~rjarry/aerc.svg)](https://builds.sr.ht/~rjarry/aerc)\n[![GitHub macOS CI status](https://github.com/rjarry/aerc/actions/workflows/macos.yml/badge.svg)](https://github.com/rjarry/aerc/actions/workflows/macos.yml)\n\n[aerc](https://sr.ht/~rjarry/aerc/) is an email client for your terminal.\n\nThis is a fork of [the original aerc](https://git.sr.ht/~sircmpwn/aerc)\nby Drew DeVault.\n\nA short demonstration can be found on [https://aerc-mail.org/](https://aerc-mail.org/)\n\nJoin the IRC channel: [#aerc on irc.libera.chat](http://web.libera.chat/?channels=aerc)\nfor end-user support, and development.\n\n## Usage\n\nOn its first run, aerc will copy the default config files to `~/.config/aerc`\non Linux or `~/Library/Preferences/aerc` on MacOS (or `$XDG_CONFIG_HOME/aerc` if set)\nand show the account configuration wizard.\n\nIf you redirect stdout to a file, logging output will be written to that file:\n\n    $ aerc \u003e log\n\nNote that the default HTML filter additionally needs `w3m` to be installed\nalong with optional `unshare` (from `util-linux`) or `socksify` (from\n`dante-utils`).\n\n### Documentation\n\nAlso available as man pages:\n\n- [aerc(1)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc.1.scd)\n- [aerc-accounts(5)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-accounts.5.scd)\n- [aerc-binds(5)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-binds.5.scd)\n- [aerc-config(5)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-config.5.scd)\n- [aerc-imap(5)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-imap.5.scd)\n- [aerc-jmap(5)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-jmap.5.scd)\n- [aerc-maildir(5)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-maildir.5.scd)\n- [aerc-notmuch(5)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-notmuch.5.scd)\n- [aerc-patch(7)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-patch.7.scd)\n- [aerc-search(1)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-search.1.scd)\n- [aerc-sendmail(5)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-sendmail.5.scd)\n- [aerc-smtp(5)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-smtp.5.scd)\n- [aerc-stylesets(7)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-stylesets.7.scd)\n- [aerc-templates(7)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-templates.7.scd)\n- [aerc-tutorial(7)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-tutorial.7.scd)\n- [carddav-query(1)](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/carddav-query.1.scd)\n\nUser contributions and integration with external tools:\n\n- [wiki](https://man.sr.ht/~rjarry/aerc/)\n\n## Installation\n\n### Binary Packages\n\nRecent versions of aerc are available on:\n\n- [Alpine](https://pkgs.alpinelinux.org/packages?name=aerc)\n- [Arch](https://archlinux.org/packages/extra/x86_64/aerc/)\n- [Debian](https://tracker.debian.org/pkg/aerc)\n- [Fedora](https://packages.fedoraproject.org/pkgs/aerc/aerc/)\n- [openSUSE](https://build.opensuse.org/package/show/openSUSE:Factory/aerc)\n- [macOS through Homebrew](https://formulae.brew.sh/formula/aerc)\n- [Slackware](https://slackbuilds.org/result/?search=aerc)\n\nAnd likely other platforms.\n\n### From Source\n\nInstall the dependencies:\n\n- go (\u003e=1.22) *(Go versions are supported until their end-of-life; support for\n  older versions may be dropped at any time due to incompatibilities or newer\n  required language features.)*\n- [scdoc](https://git.sr.ht/~sircmpwn/scdoc)\n- GNU make\n\nThen compile aerc:\n\n    $ gmake\n\naerc optionally supports notmuch. To enable it, you need to have a recent\nversion of [notmuch](https://notmuchmail.org/#index7h2), including the header\nfiles (notmuch.h). The `notmuch` build tag should be automatically added. To\ncheck if it is, run the following command:\n\n    $ ./aerc -v\n    aerc 0.14.0-108-g31e1cd9af565 +notmuch (go1.19.6 amd64 linux)\n                                  ^^^^^^^^\n\nIf it is not, you can force it before building:\n\n    $ gmake GOFLAGS=-tags=notmuch\n\nIf you have notmuch headers available but do not want to build notmuch support\nin aerc, force GOFLAGS to an empty value:\n\n    $ gmake GOFLAGS=\n\nTo install aerc locally:\n\n    # gmake install\n\nBy default, aerc will install config files to directories under `/usr/local/aerc`,\nand will search for templates and stylesets in these locations in order:\n\n- `${XDG_CONFIG_HOME:-~/.config}/aerc`\n- `${XDG_DATA_HOME:-~/.local/share}/aerc`\n- `/usr/local/share/aerc`\n- `/usr/share/aerc`\n\nAt build time it is possible to add an extra location to this list and to use\nthat location as the default install location for config files by setting the\n`PREFIX` option like so:\n\n    # gmake PREFIX=/custom/location\n    # gmake install PREFIX=/custom/location\n\nThis will install templates and other config files to `/custom/location/share/aerc`,\nand man pages to `/custom/location/share/man`. This extra location will have lower\npriority than the XDG locations but higher than the fixed paths.\n\n## Contributing\n\nAnyone can contribute to aerc. Please refer to [the contribution\nguidelines](https://git.sr.ht/~rjarry/aerc/tree/master/item/CONTRIBUTING.md)\n\n## Resources\n\nAsk for support or follow general discussions on\n[~rjarry/aerc-discuss@lists.sr.ht](https://lists.sr.ht/~rjarry/aerc-discuss).\n\nSend patches and development related questions to\n[~rjarry/aerc-devel@lists.sr.ht](https://lists.sr.ht/~rjarry/aerc-devel).\n\nInstructions for preparing a patch are available at\n[git-send-email.io](https://git-send-email.io)\n\nSubscribe to release announcements on\n[~rjarry/aerc-announce@lists.sr.ht](https://lists.sr.ht/~rjarry/aerc-announce)\n\nSubmit *confirmed* bug reports and *confirmed* feature requests on\n[https://todo.sr.ht/~rjarry/aerc](https://todo.sr.ht/~rjarry/aerc).\n\n[License](https://git.sr.ht/~rjarry/aerc/tree/master/item/LICENSE).\n\n[Change log](https://git.sr.ht/~rjarry/aerc/tree/master/item/CHANGELOG.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frjarry%2Faerc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frjarry%2Faerc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frjarry%2Faerc/lists"}