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.


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

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.2.tar.gz (40.6 kB view hashes)

Uploaded Source

Built Distribution

wallabag_client-1.8.2-py3-none-any.whl (40.3 kB view hashes)

Uploaded Python 3

Supported by

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