Skip to main content

Python application codecov PyPI version shields.io

wallabag-client

Wallabag-client is a command line client for the self hosted read-it-later app wallabag. 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


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:

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 for more details.

Metadata

Release files for wallabag-client 1.8.12

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for wallabag-client 1.8.12
File Size Uploaded
wallabag_client-1.8.12.tar.gz 46.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for wallabag-client 1.8.12
File Interpreter ABI Platform
wallabag_client-1.8.12-py3-none-any.whl Python 3 none any Details

Total release size: 87.8 kB

Release files / wallabag_client-1.8.12.tar.gz

Download URL wallabag_client-1.8.12.tar.gz
Size 46.6 kB
Tags Source
SHA-256 checksum
How to use checksums
03e149bb222bbf80313d754a62c0d7d2ab2f7ac5b7f06599a7cbe1f579469c3e
BLAKE2b-256 checksum
How to use checksums
36085a85e8bc76e52f11bab48393cb813645b76f5ff0d2cb4288c9551c5130dd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.11

Release files / wallabag_client-1.8.12-py3-none-any.whl

Download URL wallabag_client-1.8.12-py3-none-any.whl
Size 41.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2d93a25caf9a5ca28e2a7df16e15f3b6c60bbd9eb34858ca851897c9a4b95f78
BLAKE2b-256 checksum
How to use checksums
115f88fc9ed3ade5963f958745e38e1b3c125433dc334d500b05d48ca86f4714
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.11

Release history Release notifications | RSS feed

This release

1.8.12 This release

2 release files

1.8.11

2 release files

1.8.9

2 release files

1.8.8

2 release files

1.8.7

2 release files

1.8.6

2 release files

1.8.5

2 release files

1.8.4

2 release files

1.8.3

2 release files

1.8.2

2 release files

1.8.1

2 release files

1.8.0

2 release files

1.7.1

2 release files

1.7.0

2 release files

1.6.4

2 release files

1.6.3

2 release files

1.6.2

2 release files

1.6.1

2 release files

1.6.0

2 release files

1.5.0

2 release files

1.4.1

2 release files

1.4.0

2 release files

1.3.0

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page