CLI overview
The avera command-line tool for library, notes, writer, and screening automation.
The avera CLI shares your desktop library database. Use it for scripting, agents, and batch workflows.
Check status
avera --json statusConfirms database path, paper/note counts, whether the app is running, and Writer eligibility (writer.signedIn, writer.subscribed).
Optional: avera status --check-migrations exits with an error if the schema is not ready.
Global options
| Option | Effect |
|---|---|
--json | Machine-readable output on stdout |
--verbose | Extra logging on stderr |
--no-notify | Do not notify a running app to refresh UI |
--db <path> | Use an alternate database file |
Environment variables AVERA_DB_PATH and AVERA_USER_DATA override default locations.
Plan before you write
Preview destructive or complex commands without changing data:
avera plan import-doi 10.1038/nature12373 --jsonSchema and errors
avera schema --json— list JSON shapes for--jsonoutputavera schema --command manuscripts.outline --json— one schemaavera errors --json— stable error codes (auth, subscription, validation)
Live sync with the app
When Avera is open, most commands notify the UI to refresh. Use --no-notify to import quietly.
See Sync and the command reference.
Auth for Writer and screening
- Manuscript commands need an active subscription.
- Screening / reviews need subscription and a cached sign-in (open the app signed in once).
Sign in through the desktop app so auth cache populates.
Install path
The CLI ships with the desktop app. Developers build with npm run build:cli and invoke npm run cli -- <args> or avera after linking.
Default data on macOS is under ~/Library/Application Support/Avera with avera.db as the library database.