Crate bogrep

source ·
Expand description

Bogrep downloads and caches your bookmarks in plaintext without images or videos. Use the Bogrep CLI to grep through your cached bookmarks in full-text search.

Examples

# Configure the path to the bookmarks file (e.g. of your browser)
bogrep config --source "my/path/to/bookmarks_file.json"

# Import bookmarks
bogrep import

# Fetch and cache bookmarks
bogrep fetch

# Search your bookmarks in full-text search
bogrep <pattern>

Modules

  • cmd
    Available commands.
  • html
    Helper functions to work with HTML.
  • json
    Helper function to work with JSON.
  • test_utils
    Utilities used in testing.
  • utils
    Utilities to work with files (create, open, read, write).

Structs

  • Args
    Describes the available arguments in the CLI.
  • Cache
    The cache to store fetched bookmarks.
  • ChromeBookmarkReader
    A bookmark reader to read bookmarks in JSON format from Chromium or Chrome.
  • Client
    A client to fetch websites.
  • Config
    A configuration for running Bogrep.
  • ConfigArgs
    Describes the arguments for the config subcommand.
  • FetchArgs
    Describes the arguments for the fetch subcommand.
  • FirefoxBookmarkReader
    A bookmark reader to read bookmarks in JSON format from Firefox.
  • IgnoreArgs
    Describes the arguments for the ignore subcommand.
  • InitArgs
    Describes the arguments for the init subcommand.
  • MockCache
    The cache to store fetched bookmarks.
  • MockClient
    A mock client to fetch websites used in testing.
  • Settings
    Describes the settings used in Bogrep.
  • SimpleBookmarkReader
    A bookmark reader to read bookmarks from a simple text file with one url per line.
  • Source
    The source of bookmarks.
  • SourceBookmarks
    Describes the bookmark url from a specific source, like Firefox or Chrome.
  • TargetBookmark
    A standardized bookmark for internal bookkeeping that is created from the SourceBookmarks.
  • TargetBookmarks
    A wrapper for a collection of TargetBookmarks that is stored in the bookmarks.json file.

Enums

  • Subcommands
    Describes the available subcommands in the CLI.

Traits

  • Caching
    A trait to manage the cache in a file system or a mock cache used in testing.
  • Fetch
    A trait to fetch websites from a real or mock client.
  • ReadBookmark
    A trait to read bookmarks from multiple sources, like Firefox or Chrome.