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§
- Available commands.
- The errors which can occur in Bogrep.
- Helper functions to work with HTML.
- Helper function to work with JSON.
- Utilities used in testing.
- Utilities to work with files (create, open, read, write).
Structs§
- Describes the available arguments in the CLI.
- A cache to store the fetched bookmarks.
- A bookmark reader to read bookmarks in JSON format from Chromium or Chrome.
- A client to fetch websites.
- A configuration for running Bogrep.
- Describes the arguments for the
config
subcommand. - Describes the arguments for the
fetch
subcommand. - A bookmark reader to read bookmarks in JSON format from Firefox.
- A mock cache to store fetched bookmarks used in testing.
- A mock client to fetch websites used in testing.
- A bookmark reader to read bookmarks in plist format from Safari.
- Describes the settings used in Bogrep.
- A bookmark reader to read bookmarks from a simple text file with one url per line.
- A bookmark from a specific source, like Firefox or Chrome.
- Describes the bookmark url which originates from one or more sources.
- A standardized bookmark for internal bookkeeping that is created from the
SourceBookmarks
. - A wrapper for a collection of
TargetBookmark
s that is stored in thebookmarks.json
file.
Enums§
- The action to be performed on the bookmark.
- The type used to identify a source.
- Describes the available subcommands in the CLI.
Traits§
- A trait to manage the cache in a file system or a mock cache used in testing.
- A trait to fetch websites from a real or mock client.
- A trait to read bookmarks from multiple sources, like Firefox or Chrome.