> For the complete documentation index, see [llms.txt](https://wiki.crosswatch.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.crosswatch.app/getting-started/support-matrix/tooling-and-workflows.md). # Tooling and workflows This section covers the main CrossWatch tools and workflows outside of standard syncing. {% hint style="info" %} Use these tools to debug, recover, and handle edge cases without changing your main pair design. {% endhint %} ### Application tooling matrix | Tool or screen | Supported | Main capabilities | | ----------------------- | ---------------------------------------------------: | -------------------------------------------------------------------------------- | | Connections | | Configure providers, profiles, and pairs | | Synchronization | | Run all pairs or selected pairs in one-way or two-way mode | | Unified Watchlist | | Combine configured watchlists into one view | | Quick Add | | Search TMDb and write history, watchlist, and ratings | | Playback Progress | | Inspect, update, clear, and complete resume items | | Captures | | Create, inspect, compare, restore, and delete captures | | Analyzer | | Diagnose state, artifacts, watermarks, unresolved items, and blackbox issues | | Editor | | Inspect and edit tracker state, provider state, pair datasets, and manual blocks | | Backup and Restore | | Create, validate, upload, download, restore, schedule, and retain ZIP backups | | Export | | Create import files for supported external workflows | | Scheduler | | Run standard schedules, advanced jobs, and manual triggers | | Activity | | Recent sync and scrobble activity | | Output | | Separate Sync, Watcher, and Debug tabs | | Health and probes | | Provider configuration, authentication, and health checks | | Dashboard | | Configurable media and activity widgets | | Maintenance | | Clear caches and state, inspect local tracker, reset data, and restart | | Local tracker | | CrossWatch itself can be a sync endpoint | | Metadata resolver | | TMDb metadata, images, IDs, score, and runtime enrichment | | Anime mapping | | Local AniBridge data for AniList watchlist and ratings | | Statistics | | Runtime and sync statistics | | Local UI authentication | | Optional username and password authentication | | HTTPS | | Self-signed or custom TLS certificate | | Telemetry toggle | | Usage telemetry can be disabled | ### Quick Add and manual writes | Capability | Supported | Notes | | ---------------------------- | ---------------------------------------------------: | ------------------------------------------------ | | TMDb movie search | | Requires a TMDb API key | | TMDb show search | | Requires a TMDb API key | | Write watched history | | Only offered to providers with history support | | Add to watchlist | | Only offered to providers with watchlist support | | Write a rating | | Rating range is 1 to 10 | | Select multiple providers | | Provider-instance aware | | Watched date today | | Uses the current UTC timestamp | | Custom watched date | | Uses a selected calendar date | | Release date as watched date | | Fetches the release or first-air date from TMDb | | External ID enrichment | | Adds TMDb, IMDb, and TVDB IDs when available | ### Captures and snapshots | Capability | Supported | Notes | | ---------------------------------- | ---------------------------------------------------: | -------------------------------------------------------------------------- | | Capture watchlist | | Provider and profile-aware | | Capture ratings | | Provider and profile-aware | | Capture history | | Provider and profile-aware | | Capture progress | | Provider and profile-aware | | Full capture | | Can contain multiple feature child captures | | List captures | | | | Read capture content | | | | Basic comparison | | Added, removed, and changed summaries | | Extended comparison | | Feature selection, search, paging, kind filters, and nested change details | | Restore by merge | | Adds or updates capture data | | Clear and restore | | Clears the destination feature first | | Delete capture | | Optional deletion of child captures | | Clear selected provider features | | Maintenance operation | | Local CrossWatch tracker snapshots | | Automatic snapshots before local changes | | Local retention | | Days and maximum snapshot count are configurable | ### Backup and restore | Capability | Supported | Notes | | ----------------------------- | ---------------------------------------------------: | ---------------------------- | | Create manual backup | | ZIP archive | | Application state scope | | Default scope | | Include captures | | Optional | | Include reports | | Optional | | Include cache | | Optional | | List backups | | | | Download backup | | | | Upload backup | | ZIP only, size-limited | | Validate before restore | | | | Restore backup | | Creates a pre-restore backup | | Restart after restore | | Optional | | Delete backup | | | | Scheduled backups | | Time and day selection | | Retention by age | | | | Retention by maximum count | | | | Automatic old backup deletion | | Optional | ### Export compatibility #### Feature support by export target | Export target | Watchlist | History | Ratings | Combined history and ratings | | ------------- | ---------------------------------------------------: | ---------------------------------------------------: | ---------------------------------------------------: | ---------------------------------------------------: | | Letterboxd | | | | | | IMDb | | | | | | JustWatch | | | | | | Yamtrack | | | | | | TMDb workflow | | | | | #### Media support and limitations | Export target | Media types | Important limitations | | ------------- | ------------------------------------------------------- | -------------------------------------------------------------------- | | Letterboxd | Movies only | Watched dates are normalized. Files over 1 MB may require splitting. | | IMDb | Rows with an IMDb ID | Watchlist only | | JustWatch | Movies, shows, seasons, episodes | Export file, not a direct API sync provider | | Yamtrack | Movies, shows, seasons, episodes | Rating-only rows in combined export are skipped | | TMDb workflow | Movies, shows, seasons, episodes where identity permits | Produces account-import-compatible CSV structures | | Export control | Supported | | ------------------------------ | ---------------------------------------------------: | | Select source provider | | | Select source profile | | | Select feature | | | Select media types | | | Search and filter rows | | | Preview compatibility warnings | | | Missing identity filtering | | | Invalid watched date reporting | | ### Scheduler | Schedule mode | Supported | Notes | | ---------------------- | ---------------------------------------------------: | ---------------------------------------- | | Hourly | | Standard scheduler | | Every N hours | | Default is every 12 hours | | Daily at a fixed time | | 24-hour time | | Custom minute interval | | Minimum 15 minutes | | Advanced jobs | | Multiple targeted jobs | | Scheduled backups | | Stored under advanced scheduling | | Trigger now | | Can execute a provided scheduler payload | | Stop scheduler | | | | Replan next run | | Refreshes the live worker | | Show status | | | | Show next run | | | ### Dashboard and interface | Capability | Supported | Notes | | ------------------------------------ | ---------------------------------------------------: | ------------------------------------------------------------ | | Flat dark theme | | | | Flat light theme | | | | Original theme | | | | Watchlist preview | | Configurable | | Now Playing card | | Configurable | | Recent scrobble activity | | Configurable | | Recent history widget | | Configurable | | Latest ratings widget | | Configurable | | Recent sync widget | | Count or time-window display | | Configurable dashboard media widgets | | Added on current `main` | | Quick Add desktop drawer | | Configurable | | Quick Add mobile button | | Configurable | | Sync output tab | | Sync execution output | | Watcher output tab | | Watcher and scrobble output | | Debug output tab | | Provider diagnostics mirrored into the UI | | Docker stdout diagnostics | | Debug diagnostics continue to be written to container output | | Responsive web interface | | Desktop and mobile controls are present | ### Analyzer coverage | Diagnostic area | Supported | | ----------------------------------------------- | ---------------------------------------------------: | | Main state file | | | Manual policy state | | | Pair-scoped state files | | | Provider watermarks | | | Shadow state | | | Provider indexes | | | Unresolved state | | | Flap state | | | Blackbox state | | | Provider sync modules | | | Orchestrator modules | | | Artifact parse failures | | | Error, warning, and information severity totals | | | Category and problem type totals | | | Multiple selected pairs | | | Safe path validation | | ### Editor coverage | Editor source | Supported | Operations | | --------------------------------------------------- | ---------------------------------------------------: | ------------------------------------- | | CrossWatch tracker data | | Read, edit, save, import, and export | | Current orchestrator state | | Inspect baseline items | | Manual policy state | | Add forced items and block items | | Provider profile state | | Instance-aware | | Pair datasets | | Inspect and save pair-scoped data | | Tracker snapshots | | Select historical data | | Watchlist data | | | | History data | | | | Ratings data | | | | Progress data | | | | ZIP export and import | | Tracker editor data exchange | | Automatic module checkpoint before provider changes | | Protects state before remote mutation | ### Maintenance operations | Operation | Supported | Notes | | -------------------------------------------------------- | ---------------------------------------------------: | -------------------------------------------------------- | | Overview cleanup | | Runs the standard local cleanup sequence | | Inspect provider cache | | Shows files and metadata | | Retry provider items | | Preserves activity files and the identity cache | | Refresh artwork and metadata | | Removes local artwork and metadata cache | | Rebuild sync state | | Removes saved provider baselines | | Inspect CrossWatch local tracker | | Shows local state and snapshots | | Reset local tracker | | Can clear tracker state files, snapshots, or both | | Clear Recent Scrobbles | | Removes only local scrobble rows | | Rebuild statistics | | Clears statistics, reports, and Insights cache | | Clear currently playing | | Removes the local live playback session file | | Clear all captures | | Deletes saved provider captures | | Factory reset | | Backs up `config.json` first | | Restart CrossWatch | | Exits for container or process-supervisor restart | | Remove reports, caches, and generated state during reset | | Includes sync reports, tracker data, cache, and TLS data | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://wiki.crosswatch.app/getting-started/support-matrix/tooling-and-workflows.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.