Troubleshooting Waymaker Sync
This guide helps you diagnose and fix common Waymaker Sync issues. Start with Quick Checks, then move to specific issues if needed.
Troubleshooting Waymaker Sync
Difficulty: Intermediate
Overview
This guide helps you diagnose and fix common Waymaker Sync issues. Start with Quick Checks, then move to specific issues if needed.
Quick Checks
Before diving into specific issues, verify these basics:
1. Check Sync Status
waymaker_sync_status
Expected output:
running: truefilesWatched: [number > 0]errorCount: 0
2. Verify Configuration
Check .commander/config.json exists and contains valid IDs.
3. Confirm Environment Variables
echo $WAYMAKER_API_KEY
echo $WAYMAKER_APPS_URL
Both should print values (not empty).
Common Issues
Files Not Syncing
Symptoms: Create/edit markdown file, nothing appears in Commander.
Checklist:
-
Frontmatter present?
--- sync: type: task ---Files without
sync:are ignored. -
File in watched folder? Check
watch_patternsin config. Default:docs/**/*.md -
File extension correct? Only
.mdfiles are synced. -
Ignored by pattern? Check
ignore_patternsdoesn't exclude your file.
Fix: Add proper frontmatter and ensure file is in a watched folder.
Files Watched = 0
Symptoms: waymaker_sync_status shows filesWatched: 0
Causes:
- Sync daemon not fully initialized
- Watch patterns don't match any files
- Project path incorrect
Fixes:
- Wait a moment - Initial scan takes a few seconds
- Check watch patterns:
"watch_patterns": ["docs/**/*.md"] - Verify files exist:
ls docs/**/*.md
Documents Not Visible in Explorer
Symptoms: Sync reports success, but documents don't appear in Commander's Explorer.
Causes:
- Organization ID mismatch
- Folder filtering in Explorer
- Query not including organization docs
Fixes:
- Check organization_id in
.commander/config.jsonmatches your Commander organization - Clear Explorer filters - Click "All Documents"
- Refresh Commander - Hard refresh with Cmd+Shift+R
Authentication Errors
Symptoms: Sync fails with "unauthorized" or "401" errors.
Fixes:
-
Verify API key:
echo $WAYMAKER_API_KEYShould start with
wm_or be a valid service key. -
Check key hasn't expired - Generate new key in Waymaker One Settings
-
Verify service key:
echo $WAYMAKER_APPS_SERVICE_KEYShould be your service role key.
Frontmatter Parse Errors
Symptoms: Sync fails with YAML parsing errors.
Common mistakes:
# WRONG - missing indentation
---
sync:
type: task
---
# WRONG - missing space after colon
---
sync:
type:task
---
# WRONG - incorrect delimiters
--
sync:
type: task
--
# CORRECT
---
sync:
type: task
---
Fix: Use exactly 2 spaces for indentation, space after colons.
Bidirectional Sync Not Working
Symptoms: IDE to Commander works, but Commander changes don't sync back.
Causes:
- Mode set to
ide-to-commanderonly - Missing
taskboard_idin config - Real-time sync connection failed
Fixes:
-
Check sync mode:
"sync": { "mode": "bidirectional" } -
Verify taskboard_id is set in
.commander/config.json -
Check daemon startup logs for:
✅ Commander → IDE sync started (Reverse Sync)— working⚠️ Reverse sync disabled (no taskboard_id configured)— fix config⚠️ Failed to start reverse sync— check error details
File Encoding Errors
Symptoms: Sync fails with encoding errors, corrupted characters (U+FFFD), or "invalid UTF-8" messages.
Causes:
- File not saved as UTF-8
- Copy-paste from Word, Google Docs, or PDFs
- Windows-1252 or other legacy encodings
Characters to Watch:
- Smart quotes:
" "' '(curly quotes) - Em-dashes:
—(long dash) - Ellipsis:
…(single character) - Trademark symbols:
™®© - Accented characters from non-UTF-8 sources
Diagnosis:
# Check file encoding
file --mime-encoding yourfile.md
# Find non-UTF-8 files in a directory
find . -name "*.md" -exec file --mime-encoding {} \; | grep -v utf-8
Fixes:
-
Re-save as UTF-8 in your editor:
- VS Code: Click encoding in status bar → "Save with Encoding" → "UTF-8"
- Cursor: Same as VS Code
-
Convert file:
iconv -f WINDOWS-1252 -t UTF-8 badfile.md > goodfile.md -
Replace problem characters manually (search for
�replacement character)
Sync Conflicts (Both Sides Edited)
Symptoms: .conflict.md file appears alongside your original file.
What happened: Both you (in IDE) and someone else (in Commander) edited the same task while the sync daemon was offline.
How it works:
- The
.conflict.mdfile contains YOUR local version - The main
.mdfile contains the Commander version - You must manually resolve
Resolution:
- Open both files side by side
- Merge changes into the main file
- Delete the
.conflict.mdfile - Save — sync will push the merged version
Example:
docs/02-working/tasks/backlog/my-task.md # Commander version
docs/02-working/tasks/backlog/my-task.conflict.md # Your local version
Prevention: Keep the sync daemon running when actively collaborating.
Duplicate Documents
Symptoms: Same file creates multiple documents in Commander.
Causes:
document_idnot saved after first sync- Config reset
Fixes:
-
Commit sync metadata:
git add docs/ git commit -m "docs: update sync IDs" -
Don't delete auto-generated IDs from frontmatter:
sync: type: task document_id: "abc123" # Keep this!
Diagnostic Commands
Check MCP Server Status
waymaker_sync_status
View Recent Errors
The status output includes recentErrors array with last 10 errors.
Check Status File Directly
When the daemon is running, it writes status to .commander/sync-status.json:
cat .commander/sync-status.json
This file contains:
running: true/falsefilesWatched: [number]syncCount: [total syncs]errorCount: [total errors]recentErrors: [last 10 errors]updatedAt: [timestamp]
If this file is missing or stale (>10 seconds old), the daemon may have crashed.
Test Configuration
waymaker_sync_configure action=validate
Error Reference
Quick lookup for common sync errors:
| Error Message | Cause | Fix |
|---|---|---|
401 Unauthorized | Token expired or invalid | waymaker auth login |
CLERK_AUTH_FAILED | Edge function auth issue | Check API key, re-login |
unique_markdown_name_per_workspace | Duplicate document name | Clear .commander/sync-index.json, re-sync |
unsupported Unicode escape sequence | Non-UTF-8 content in file | Fix encoding |
idx_unique_folder_name | Folder race condition | Reduce --concurrency |
Unhandled error in [file] | File caused sync crash | Check file content, fix and retry |
Token expired. Run waymaker auth login | OAuth token TTL exceeded | waymaker auth login |
No taskboard_id configured | Missing config | Run waymaker init with taskboard |
Reverse sync disabled | Missing anon key or config | Check daemon startup logs |
CONFLICT detected | Both sides edited same file | Resolve conflict |
Getting More Help
Information to Include
When contacting support, include:
- Output of
waymaker_sync_status - Your
.commander/config.json(redact sensitive IDs) - Example file that won't sync (with frontmatter)
- Error messages from MCP server
Support Channels
- Email: support@waymakerone.com
- X/Twitter: @stuartdotleo
Related Articles
Still stuck? Email support@waymakerone.com with diagnostic info.