• Description
• Features
• Installation and Configuration
• Image Caching
• Retrieve new entries after =M-x wallabag=
• Use org-protocol to save page
• Use AI to generate summary
• Keybindings

Emacs Wallabag client.

• Request all entries
• Request all tags
• Add tags for one entry
• Delete tag for one entry
• Request format for one entry
• Add entry (Support from eaf browser or elfeed or org-protocol)
• Insert entry with provided html (Support from eaf browser or elfeed or org-protocol)
• Delete entry
• Copy as org/markdown/org-protocol links
• Offline database (Sqlite)
• Full update
• Sidebar supported
• Select with Ivy/Consult
• sync with all clients (mobile, web, browser extension etc)
• Beautify: Support shrface
• Real time search and filtering (space separated)
• Annotation: Support paw
• Cache support: Saved placed/AI Summary Cache
• Org Protocol Support

This project relies on emacs-request and emacsql. Please install them in advanced.

git clone https://github.com/chenyanming/wallabag.el.git ~/.emacs.d/lisp/wallabag/

It’s available on Melpa :

M-x package-install wallabag

(add-to-list 'load-path "~/.emacs.d/lisp/wallabag/")
(require 'wallabag)
(setq wallabag-host "https://xx.xx.xx") ;; wallabag server host name
(setq wallabag-username "xx") ;; username
(setq wallabag-password "xx") ;; password
(setq wallabag-clientid "xx") ;; created with API clients management
(setq wallabag-secret "xx") ;; created with API clients management
(setq wallabag-search-print-items '("title" "domain" "tag" "reading-time" "date")) ;; control what content should be show in *wallabag-search*
(setq wallabag-search-page-max-rows 32) ;; how many items shown in one page

(use-package wallabag
  :defer t
  :load-path "~/.emacs.d/lisp/wallabag/"
  :config
  (setq wallabag-host "https://xx.xx.xx") ;; wallabag server host name
  (setq wallabag-username "xx") ;; username
  (setq wallabag-password "xx") ;; password
  (setq wallabag-clientid "xx") ;; created with API clients management
  (setq wallabag-secret "xx") ;; created with API clients management
  (setq wallabag-search-print-items '("title" "domain" "tag" "reading-time" "date")) ;; control what content should be show in *wallabag-search*
(setq wallabag-search-page-max-rows 32) ;; how many items shown in one page
  ;; (setq wallabag-db-file "~/OneDrive/Org/wallabag.sqlite") ;; optional, default is saved to ~/.emacs.d/.cache/wallabag.sqlite
  )

(use-package wallabag
  :straight (:host github :repo "chenyanming/wallabag.el" :files ("*.el" "*.alist" "*.css")))

(package! wallabag :recipe (:host github :repo "chenyanming/wallabag.el" :files ("*.el" "*.alist" "*.css")))

It is insecure to store your sensitive credentials such as the wallabag password and client secret in plain text, and especially if you want to be upload it to public servers. You can use Emacs’ built-in auth-sources library for GPG-encrypted storage of your secrets.

Create an encrypted ~/.authinfo.gpg file with the lines:

machine wallabag domain "https://example.com" user "xxx" password "xxx" clientid "xxx" client-secret "xxx"

Wallabag will get the credentials when needed without saving them in memory.

You can also hardcode wallabag-host, wallabag-username, wallabag-password, wallabag-clientid, wallabag-secret but it is less secure.

Wallabag will not download the images, but using Emacs disk caching capability. Setting url-automatic-caching non-nil causes documents to be cached automatically.

(setq url-automatic-caching t)

(add-hook 'wallabag-after-render-hook 'wallabag-search-update-and-clear-filter)

Add wallabag org protocol by running:

(wallabag-org-setup-org-protocol)

Create a bookmarklet with:

• If paw-server is running, use js/wallabag_insert_entry.js (send html to paw-server, and save the page to wallabag)
• If paw-server is not running, use js/wallabag_add_entry.js (only send url to wallabag server)

M-x wallabag-summary ;; or press ?

Wallabag will use gptel to generate the summary overlay into the begining of the article.

Start with M-x wallabag. For the first time you connect to server, you need to press u to synchronize.