Skip to main content

A command-line client for the self-hosted `read-it-later` app Wallabag

Project description

badge 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wallabag_client-1.8.11.tar.gz (46.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wallabag_client-1.8.11-py3-none-any.whl (41.0 kB view details)

Uploaded Python 3

File details

Details for the file wallabag_client-1.8.11.tar.gz.

File metadata

  • Download URL: wallabag_client-1.8.11.tar.gz
  • Upload date:
  • Size: 46.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for wallabag_client-1.8.11.tar.gz
Algorithm Hash digest
SHA256 83b81c6962d7c3ed5851b1fc187fb7b131e6eb9661d9b6a593c6027c1e5b8b07
MD5 52e21828b392111a9d1bdaaba6f389e7
BLAKE2b-256 d4ff0f122f5aa91fdfb600473583cfe99bef66972d42627ae01031bf57989936

See more details on using hashes here.

File details

Details for the file wallabag_client-1.8.11-py3-none-any.whl.

File metadata

File hashes

Hashes for wallabag_client-1.8.11-py3-none-any.whl
Algorithm Hash digest
SHA256 5413bf47e7b38c3c4debb3ce61ef679208327b2d8797a2245eebbe1abfbd8f1c
MD5 2379f4f576cdd57b2c38bf3674582a59
BLAKE2b-256 1924de0f6f418debef1add98e5b7c928610ffc72efe643b742991c82199a7b4e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page