https://github.com/neomutt/contrib-keybase

Keybase Integration
https://github.com/neomutt/contrib-keybase

Last synced: 10 months ago
JSON representation

Keybase Integration

• Host: GitHub
• URL: https://github.com/neomutt/contrib-keybase
• Owner: neomutt
• License: unlicense
• Created: 2022-06-12T21:56:15.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-06-12T21:56:18.000Z (about 4 years ago)
• Last Synced: 2025-03-12T16:15:03.106Z (over 1 year ago)
• Language: Shell
• Size: 187 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# KeybaseMutt

A work in progress. KeybaseMutt exists to let its users utilize Keybase within

NeoMutt. (Unfortunately, not natively (yet).)

## Quick start

Run the install script. It will set up the directory's and paths for you. Do

what it says or suffer the consequences!

Then just throw these into your .muttrc

`set editor = 'echo %s > ~/.neomutt/keybaseMutt/.tmp; vim %s'`

`macro compose K "unset wait_keypython ~/.neomutt/keybaseMutt/keybase.pyset wait_key`

Done!

## How to use KeybaseMutt

Write an email. In the screen right before you send your email (called the pager mode), press "K".

![](pagerMode.png)

(Press 'K' when you're here)

You can now use four Keybase commands in this "shell". (I thought it best to limit the user to four commands for security reasons. Running unusual commands would overwrite the email, forcing the user to rewrite the email again.)

The commands are:

- `keybase encrypt [user]`

- `keybase pgp encrypt [user]`

- `keybase sign`

- `keybase pgp sign`

## Decrypting and verifying messages

Unfortunately, there isn't an easy way to decrypt or verify messages through a macro. Instead, you'll need to use the pipe feature of neomutt.

Opening the email, you'll need to navigate to the actual attachment. (Press "V" when you're reading the email.)

![](attachmentView.png)

Then pipe ("|") it through the one of the scripts. (like "pgpverify.sh" or "decrypt.sh")

Please note, using an attachment is very important when decrypting emails that include html. The scripts are unable to separate html and text.

Make sure that the attachment is "text/plain" rather than "text/html".