README file from
GithubScrevi Sync
This official plugin maintained by the Screvi team enables you to easily and automatically export all your highlights from Screvi to Obsidian.
Features
- Automatic Sync: Automatically sync your highlights at regular intervals
- Manual Sync: Sync on-demand with a single click
- Organized by Source: Highlights are automatically organized by source type (books, articles, tweets, etc.)
Installation
Once approved on the Obsidian community plugin store:
- Open Obsidian Settings
- Go to Community Plugins
- Click "Browse" and search for "Screvi Sync"
- Click Install, then Enable
Manual installation
Until the plugin lands in the community store, install it directly from a GitHub release:
- Download both files from the latest release:
main.jsmanifest.json
- In your vault, create the folder
.obsidian/plugins/screvi/(the folder name must be exactlyscrevi). - Move the two downloaded files into that folder.
- In Obsidian, open Settings → Community plugins. Make sure Restricted mode is off, then click the reload icon next to Installed plugins.
- Enable Screvi Sync in the list.
To update later, repeat steps 1–3 with the new release files and reload Obsidian.
Setup
- Get your Screvi API key from screvi.com/settings/api
- Open Plugin Settings
- Enter your API key
- Configure sync preferences (optional)
- Click "Sync Now" to get started
Requirements
- A Screvi account with an active trial or subscription
Network use and privacy
This plugin connects to a single host — https://api.screvi.com — to read your highlights. It uses your API key from the settings tab for authentication and sends no other data.
When Auto sync is enabled (default: on, every 2 hours), the plugin polls api.screvi.com on a timer in the background to fetch new highlights. You can change the interval, or disable auto-sync entirely and trigger syncs manually, in Settings → Screvi Sync.
No analytics, telemetry, or third-party services are contacted.