Skip to content

Commit ae1aad0

Browse files
committed
cli sync precision
1 parent 7208c71 commit ae1aad0

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

docs/advanced/3_cli/sync.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ local development through the [VS Codeextension](../../cli_local_dev/1_vscode-ex
1818

1919
## Raw Syncing
2020

21-
Raw syncing is a one-off operation with no state maintained. It's best used for
21+
Raw syncing is a one-off operation with no state maintained. When using Windmill EE and [Git Sync](../11_git_sync/index.mdx),
22+
this is what you should use since Git Sync will always keep your git repo up-to-date.
23+
When not used in with Git Sync. It's best used for
2224
making backups, cloning a complete workspace, and similar one-off operations.
2325

2426
Raw syncing is done using `wmill sync pull --raw` & `wmill sync push --raw`
@@ -38,10 +40,9 @@ updating the remote equivalents.
3840

3941
## Stateful Syncing
4042

41-
Stateful syncing is best used when you want to continuously synchronize a folder
42-
or git(hub) repository with a Windmill instance. The CLI will automatically
43-
maintain state for you and ensure modifications that happen concurrently on the
44-
remote and locally stay in sync.
43+
Stateful syncing is best used when your Git repo and windmill workspace might diverge (because of not using [Git Sync](../11_git_sync/index.mdx))
44+
and you want to keep track of the state the last time you pulled to check for merge conflicts.The CLI will automatically
45+
maintain state for you and ensure modifications that happen concurrently on the remote and locally stay in sync.
4546

4647
### Pulling
4748

0 commit comments

Comments
 (0)