#command-line #wallabag #client #cli

yanked wallabag-cli

Command line client for Wallabag

0.1.0 Dec 13, 2018

#1895 in #command-line

MIT/Apache

53KB
981 lines

Wallabag CLI

Command line client for Wallabag.

About

This aims to be an extensive non-interactive command line application to interact with a Wallabag server.

Goals:

  • offline first
  • full two way syncing
  • save urls direct from command line
  • list and view entries
  • export and save entries in a supported format
  • create/edit/delete entries
  • create/edit/delete annotations
  • create/edit/delete tags
  • search data

Usage

Note: to run without installing, you can use cargo run --bin <bin name>. It will need -- between this and any args meant for the target program. Eg. cargo run --bin wallabag-cli -- entry list.

It requires a valid toml config file to run. There is an example file that you can use. Edit the example (or make a copy) and point the program at it like so: wallabag-cli -c my_config.toml <args>.

First, sync everything for use. All (well, most) commands that operate on the data work solely on the local versions saved in the database.

wallabag-cli -c myconfig sync

For some things, a full sync is required (eg. remotely deleted entries):

wallabag-cli -c myconfig sync --full

List entries:

wallabag-cli -c myconfig entry list

Show an entry with ID (IDs are shown in entry list). This dumps the html output - pipe through something that can display the html for easy reading:

wallabag-cli -c myconfig entry show 1798248 | w3m -dump -T text/html

Developing

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~43MB
~859K SLoC