sync¶
Sync development environment and configurations.
Usage¶
Description¶
The sync command ensures your workspace is up to date by cloning/updating repositories and merging configurations. Running sync without a subcommand performs a full sync.
Full Sync¶
A full sync performs all of the following:
- Initializes root git repository if missing
- Creates
README.mdif missing - Clones any missing repositories (standard mode only)
- Merges VS Code configurations (settings, launch, tasks, extensions)
- Generates agent instruction files when
agentInstructions.enabledis true - Syncs GitHub Actions workflows to root
.github/workflows(monorepo mode only)
Install Sets¶
Use --install-set NAME or --set NAME to sync only repos whose repos[].installSets contains that name. This is useful for public installer workflows where a root workspace should clone and generate config only for public/runtime repos while private development repos remain excluded.
Repos without installSets are included in every selected set for backward compatibility. Running multi sync with no install set preserves the existing behavior and includes every repo.
Subcommands¶
| Subcommand | Description |
|---|---|
| sync vscode | Merge VS Code configuration files |
| sync agents | Generate AGENTS.md and CLAUDE.md from AGENTS.parts/*.md |
| sync github | Sync root GitHub Actions workflows for monorepo workspaces |
Examples¶
# Full sync (recommended)
multi sync
# Public/runtime subset
multi sync --install-set default
# Equivalent shorter form
multi sync --set default
# Only sync VS Code configurations
multi sync vscode
# Only sync VS Code settings for the selected subset
multi sync --set default vscode settings
# Only sync VS Code settings
multi sync vscode settings
# Only sync generated agent instruction files
multi sync agents
# Only sync root GitHub Actions workflow files (monorepo mode)
multi sync github
Notes¶
- The VS Code extension can automatically run
multi syncwhen relevant files change - Sync operations are idempotent - running them multiple times is safe
- Use
--verboseto see detailed output during sync - Use
--install-set/--setbefore the subcommand name when filtering a partial sync, for examplemulti sync --set default agents multi sync githubis available only whenmonoRepoistrue- Recommended automation path: create/edit
multi.jsonand runmulti sync