https://github.com/artur-shaik/wallabag-client
Command line client for the self hosted read-it-later app Wallabag
https://github.com/artur-shaik/wallabag-client
cli command-line-tool pocket reader shell wallabag
Last synced: 4 months ago
JSON representation
Command line client for the self hosted read-it-later app Wallabag
- Host: GitHub
- URL: https://github.com/artur-shaik/wallabag-client
- Owner: artur-shaik
- License: mit
- Created: 2020-09-30T04:18:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-10-13T04:36:22.000Z (8 months ago)
- Last Synced: 2025-11-17T23:11:36.285Z (7 months ago)
- Topics: cli, command-line-tool, pocket, reader, shell, wallabag
- Language: Python
- Homepage:
- Size: 345 KB
- Stars: 38
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/artur-shaik/wallabag-client/actions/workflows/test-app.yml) [](https://codecov.io/gh/artur-shaik/wallabag-client) [](https://pypi.python.org/pypi/wallabag-client/)
# wallabag-client
Wallabag-client is a command line client for the self hosted read-it-later app [wallabag](https://www.wallabag.org/). Unlike to other services, wallabag is free and open source.
Wallabag-client is refactored version of existed wallabag-cli tool.
You can read additional info [here](https://shaik.link/wallabag-client-features.html)
--------------------------------------------------------------------------------
## Features
- List entries (filterable tabulated output with nerd icons);
- Show the content of an entry with custom width and alignment;
- Add new entries;
- Delete entries;
- Mark existing entries as read;
- Mark existing entries as starred;
- Change the title of existing entries;
- Tags support;
- Annotations support;
- Opening entries in browser;
- Showing entry information;
- Export entry to file.
## Installation
`sudo pip3 install wallabag-client`
## Usage
`wallabag --help`
```
Usage: wallabag [OPTIONS] COMMAND [ARGS]...
Options:
--config TEXT Use custom configuration file
--debug Enable debug logging to stdout
--debug-level TEXT Debug level
--version Show the version and exit.
-h, --help Show this message and exit.
Commands:
add Add a new entry to wallabag.
anno Annotation commands.
config Start configuration.
delete Delete an entry from wallabag.
delete-by-tags Delete entries from wallabag by tags.
export Export entry to file.
info Get entry information.
list List the entries on the wallabag account.
open Open entry in browser.
read Toggle the read-status of an existing entry.
repl Start an interactive shell.
show Show the text of an entry.
star Toggle the starred-status of an existing entry.
tags Retrieve and print all tags.
update Toggle the read or starred status or change the title of...
update-by-tags Set the read or starred status of an existing entries...
```
## Install shell completion (zsh)
A completion script for zsh is provided in the directory `completion/zsh/_wallabag`.
Installation can vary based on your zsh settings and environment. Most importantly, the file has to be placed in one of the directories contained in the `$fpath` variable and then autoloaded.
If you want to install the completion script for all users, you can do the following:
```sh
mkdir -p /usr/local/share/zsh/site-functions
cp _wallabag /usr/local/share/zsh/site-functions
```
and restart zsh.
A better option is to have a directory in your home for local completion scripts, but setting this up is beyond the scope of these instructions. You may refer to [this answer on Stackoverflow](https://stackoverflow.com/a/67161186) for more details.