Crate bogrep

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.
• errors
  The errors which can occur in Bogrep.
• 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.
• BookmarkManager
• BookmarkService
• Cache
  A cache to store the fetched bookmarks.
• ChromiumReader
  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.
• FirefoxReader
  A bookmark reader to read bookmarks in JSON format from Firefox.
• JsonBookmark
• JsonBookmarks
• Logger
• MockCache
  A mock cache to store fetched bookmarks used in testing.
• MockClient
  A mock client to fetch websites used in testing.
• SafariReader
  A bookmark reader to read bookmarks in plist format from Safari.
• ServiceConfig
• ServiceReport
• Settings
  Describes the settings used in Bogrep.
• SimpleReader
  A bookmark reader to read bookmarks from a simple text file with one url per line.
• Source
• SourceBookmark
  A bookmark from a specific source, like Firefox or Chrome.
• SourceBookmarks
  Describes the bookmark url which originates from one or more sources.
• TargetBookmark
  A standardized bookmark for internal bookkeeping that is created from the SourceBookmarks.
• TargetBookmarkBuilder
• TargetBookmarks
  A wrapper for a collection of TargetBookmarks that is stored in the bookmarks.json file.

Enums

• Action
  The action to be performed on the bookmark.
• CacheMode
• RunMode
• SourceType
  The type used to identify a source.
• Status
• Subcommands
  Describes the available subcommands in the CLI.
• UnderlyingType

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.