A command line (CLI) program for monitoring and downloading 8chan threads. Licensed under MIT.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 2.4KB

3 years ago
3 years ago
12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. # Lizard, the 8ch monitor
  2. Lizard is a command line (CLI) program for monitoring 8ch threads. After you add a thread to its watchlist, it can connect to 8ch and check if new replies were made, notifying you if so. It will try to keep a local copy of the thread and the files in it in case the thread dies. It can also open all threads with new replies in your browser with a single command.
  3. ## Installation
  4. ### Linux
  5. 1. Make sure you have Python 3
  6. 2. Download the most recent `.whl` package from under `dist/`
  7. 3. Install with pip: `pip3 install lizard-0.<VERSION HERE>-py3-none-any.whl`
  8. If upgrading, see [wiki](https://git.teknik.io/abrax/lizard/wiki/Installation).
  9. ## Usage
  10. Running `lizard` without any arguments will print the help message explaining the syntax. It will also create a `~/lizard_data` directory to store files.
  11. After you install, run `lizard create` to create a new database (if you don't have one already). Everything else will crash unless a valid database exists.
  12. Add a thread to the database with `lizard a <URL>`. Upon adding a thread, Lizard will immediately download a copy of the thread and the files in it. These will be put under `~/lizard_data/`.
  13. You can call `lizard r` to refresh threads currently in the database, and see their status with `lizard l`. `lizard rl` combines these two steps. If you see threads with new activity (marked with `!` or `Y`), you can open those in your default browser with `lizard o` (tip: [have the browser running already before you do this](https://git.teknik.io/abrax/lizard/issues/44)).
  14. ## Changelog
  15. ### 1.1 (planned)
  16. ### 1.0 (in development)
  17. **Important note:** The database schema will change with this version. Backup your database and get ready to migrate.
  18. ### 0.4 (current)
  19. Command syntax changes:
  20. - Listing threads:
  21. - `lizard la` (list all) will produce the previous `lizard l` functionality.
  22. - `lizard l` will list only items that have had something interesting happen (reply or 404).
  23. - `lizard rl` will print the summary list.
  24. Tor features:
  25. - `lizard tor` will now auto-open the tor captcha page for convenience. ([#42](https://git.teknik.io/abrax/lizard/issues/42))
  26. - When any web request receives a 403, a more informative message is printed. ([#41](https://git.teknik.io/abrax/lizard/issues/41))
  27. Bugfixes:
  28. - `lizard create` command now working. ([#43](https://git.teknik.io/abrax/lizard/issues/45))
  29. ### Older versions
  30. See [wiki](https://git.teknik.io/abrax/lizard/wiki/Version-history).