Skip to main content

Usage

This guide covers all the ways to use BearFlare, from basic commands to advanced sync workflows.

Basic Usage

The simplest way to run BearFlare:

./bearflare.sh

This performs a full sync (both schema and data) with default settings.

Command-Line Flags

FlagDescription
-v, --verbosePrint SQL before sending
-d, --dry-runShow what would be executed without API calls
--dropDrop existing tables before creating schema
-so, --schema-onlySync schema only (skip data)
-do, --data-onlySync data only (skip schema)
-i, --incrementalSync only notes modified since last sync
-n, --note-id <id>Sync a single note by identifier
--force-overwriteDelete existing rows before inserting
-h, --helpDisplay help text

Example Commands

Full Sync

# Sync everything (schema and data)
./bearflare.sh --drop

Schema Only

# Sync only the table structure
./bearflare.sh --schema-only

Data Only

# Sync only note data
./bearflare.sh --data-only

Incremental Sync

# Sync only modified notes
./bearflare.sh --incremental

Single Note

# Sync one specific note
./bearflare.sh --note-id "ABC123-DEF456-GHI789"

Next Steps