Help & FAQ
Find answers to common questions, tips, and quick links for using BLKTXT.
How do I add a new note?
Click the Add Note button on the dashboard or use the CLI blktxt add command.
How do I filter notes by date?
Use the date filter at the top of the dashboard or stats page. You can type natural language like "last week" or use the calendar picker.
How do I sync notes with Markdown?
Go to Sync to MD File or Sync from MD File in the Actions menu. You can preview changes before confirming.
How do I merge or split notes?
Use the Merge Notes page to combine two notes, or the split feature on a note's detail page to split by line.
Where is my data stored?
All notes are stored in a local SQLite database per workspace. You can export or import notes using the Markdown sync features.
How do I change workspaces?
Switch workspaces using the CLI: blktxt workspace use <name>. The web UI uses the workspace active when the server started.
How do I use cloud sync?
Configure Azure Blob Storage in sync_config.json, then use the Cloud Sync pages for docs and tickets to upload/download your data.
How does version history work?
Automatic backups are created when you edit documents or tickets. Use the Version History pages to view, compare, and restore previous versions.
How do I manage documentation?
Use the Documentation section for wiki-style docs with search, TOC, and editing. Create new docs, edit existing ones, and track version history.
CLI & Syncing Help
Common CLI Commands
blktxt add --date 2023-01-01 --content "My note" --ref TICKET-123blktxt list --start 2023-01-01 --end 2023-01-31blktxt search "keyword"blktxt workspace listblktxt workspace use workblktxt sync-from-mdblktxt exportblktxt sync_statusblktxt sync-azure-docs --action uploadblktxt sync-azure-tickets --action downloadblktxt list-versions --type docsblktxt restore-version --type docs --version "2024-01-15T10:30:00"
How does syncing work?
- Sync to Markdown: Overwrites your Markdown file with the current database notes. Use the web UI or
blktxt exportin the CLI. - Sync from Markdown: Imports new notes from your Markdown file into the database. Use the web UI or
blktxt sync-from-mdin the CLI. - Cloud Sync: Upload/download files to Azure Blob Storage for backup and cross-device access.
- Preview changes before confirming in the web UI. The CLI will prompt for confirmation.
- Dateless notes (00/00/0000) are preserved at the top of the Markdown file.
Cloud Sync & Version History
- sync_status: Check the status of your local files and cloud configuration
- sync-azure-docs: Upload/download documentation files to/from Azure Blob Storage
- sync-azure-tickets: Upload/download database to/from Azure Blob Storage
- sync-azure-all: Sync both docs and tickets in one operation
- list-versions: View version history for docs or tickets with timestamps
- restore-version: Restore a specific version of docs or tickets from history
- All cloud operations require proper Azure configuration in
sync_config.json - Version history is automatically maintained for all synced files
Cloud Sync Setup
- Create an Azure Storage Account and get your connection details
- Edit
sync_config.jsonwith your Azure credentials - Use the Cloud Sync pages to upload/download your data
- Version history is automatically maintained for all synced files
More CLI Help
- Run
blktxt --helpfor a full list of commands. - Use
blktxt <command> --helpfor details on any command. - See the README for advanced usage and configuration.