Backup and restore
Create archives of the SQLite database and the file vault, validate them on restore via the bundled manifest, and recover from any prior point in time.
Updated
Team-X stores all data locally: your database and vault files. The backup system lets you create portable archives and restore from them.
Creating a Backup
- Go to Settings > Backup & Restore
- Click Create Backup
- Choose a destination folder in the native save dialog
- Team-X creates a
.teamx-backuparchive containing:- The SQLite database (after WAL checkpoint for consistency)
- All vault files for every company
- A
manifest.jsonwith version, timestamp, company count, file count, and total size
The backup runs in the background. A progress indicator shows the status.
What’s Included
| Data | Included |
|---|---|
| Companies and employees | Yes |
| Org chart relationships | Yes |
| All conversations and threads | Yes |
| Tickets and kanban state | Yes |
| Goals and projects | Yes |
| Meeting minutes and threads | Yes |
| Vault files | Yes |
| Telemetry/run history | Yes |
| Audit event log | Yes |
| Provider configurations | Yes (keys stored separately in keychain) |
| API keys | No (stored in OS keychain, not in the database) |
API keys are not included in backups because they live in the OS keychain. After restoring on a new machine, you’ll need to re-enter your API keys in Settings > Providers.
Restoring from Backup
Warning: Restoring replaces your current database and vault files. This operation is destructive.
- Go to Settings > Backup & Restore
- Click Restore
- Select a
.teamx-backuparchive from the file picker - Confirm the restore in the warning dialog
- Team-X:
- Validates the archive manifest
- Stops the orchestrator (pauses all agent work)
- Replaces the database and vault directories
- Restarts and reseeds if needed
The app reloads after restore completes.
Backup History
The Backup History section in Settings shows all backups created from Team-X, with:
- Timestamp
- File size
- Number of companies included
Click on a backup entry to see its full manifest details.
Backup Location
By default, backups are saved wherever you choose in the save dialog. A common pattern:
| Platform | Suggested Location |
|---|---|
| Windows | %USERPROFILE%\Documents\Team-X Backups\ |
| macOS | ~/Documents/Team-X Backups/ |
| Linux | ~/Documents/Team-X Backups/ |
Best Practices
- Back up before major changes: before firing employees, restoring a previous backup, or deleting companies
- Back up before updates: create a backup before installing a new version of Team-X
- Store backups externally: copy backups to an external drive or cloud storage for disaster recovery
- Test your backups: periodically restore a backup to verify it works (use a separate machine or user profile to avoid overwriting your live data)