render

README

Filter list rendering CLI

As an alternative to using the hosted Let's Block It service, you can use this CLI to render your list to a file, sourcing the settings from a YAML file.

You can export your current list from you account page or start from an empty file.

Example input file

title: "example list"               # Title is mandatory
instances:                          # List of instances, multiple instances of a given filter is supported
  - filter: google-search-cleanup   # Filter name, matching the template's file name
    params:                         # Map of param name -> param value
      only-results: false
      related-questions: true
      related-searches: true
  - filter: youtube-shorts          # Params is optional if the filter has no options

Check the available filters and parameters by browsing the filter sources.

How to run the render

With docker

# Run pull everytime to get the latest templates
docker pull ghcr.io/letsblockit/render:latest
# Pipe your config file into the container's default command
cat my-list.yaml | docker run -i ghcr.io/letsblockit/render:latest > output.txt

With golang

Install the golang compiler, then run:

go run github.com/letsblockit/letsblockit/cmd/render@latest my-list.yaml > output.txt