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.
- 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.
- Bookmark
Manager - Bookmark
Service - Cache
- A cache to store the fetched bookmarks.
- Chromium
Reader - 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.
- Config
Args - Describes the arguments for the
configsubcommand. - Fetch
Args - Describes the arguments for the
fetchsubcommand. - Firefox
Reader - A bookmark reader to read bookmarks in JSON format from Firefox.
- Json
Bookmark - Json
Bookmarks - Logger
- Mock
Cache - A mock cache to store fetched bookmarks used in testing.
- Mock
Client - A mock client to fetch websites used in testing.
- Safari
Reader - A bookmark reader to read bookmarks in plist format from Safari.
- Service
Config - Service
Report - Settings
- Describes the settings used in Bogrep.
- Simple
Reader - A bookmark reader to read bookmarks from a simple text file with one url per line.
- Source
- Source
Bookmark - A bookmark from a specific source, like Firefox or Chrome.
- Source
Bookmarks - Describes the bookmark url which originates from one or more sources.
- Target
Bookmark - A standardized bookmark for internal bookkeeping that is created from the
SourceBookmarks. - Target
Bookmark Builder - Target
Bookmarks - A wrapper for a collection of
TargetBookmarks that is stored in thebookmarks.jsonfile.
Enums§
- Action
- The action to be performed on the bookmark.
- Cache
Mode - RunMode
- Source
Type - The type used to identify a source.
- Status
- Subcommands
- Describes the available subcommands in the CLI.
- Underlying
Type
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.
- Read
Bookmark - A trait to read bookmarks from multiple sources, like Firefox or Chrome.