Skip to content

Commit 1f92a57

Browse files
committed
update: CLI excludeDotFiles option, sync pairs registry example
1 parent 43273ff commit 1f92a57

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

docs/cli/syncing.mdx

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Invoke `filen sync` to sync any locations with your Filen Drive. This is the sam
1414
You must specify the sync pairs (`[sync pairs...]` above) as follows:
1515

1616
- **(central registry)** `filen sync`: Read the sync pairs from `$APP_DATA/filen_cli/syncPairs.json`.
17-
This file must contain JSON of the type `{local: string, remote: string, syncMode: string, alias?: string, disableLocalTrash?: boolean, ignore?: string[]}[]`.
17+
This file must contain JSON of the type `{local: string, remote: string, syncMode: string, alias?: string, disableLocalTrash?: boolean, ignore?: string[], excludeDotFiles?: boolean}[]`.
1818
`syncMode` can be `twoWay`, `localToCloud`, `localBackup`, `cloudToLocal` or `cloudBackup` (see [here](https://blog.filen.io/how-to-desktop-client/#:~:text=for%20this%20sync.-,Sync%20Modes,-%3A) on what that means).
1919
- **(custom registry)** `filen sync <file>`: Read the sync pairs from a custom JSON file (same type as above).
2020
- **(aliases)** `filen sync mypair myotherpair`: Sync the sync pairs from the central registry that were given the aliases `mypair` and `myotherpair`.
@@ -25,3 +25,24 @@ You must specify the sync pairs (`[sync pairs...]` above) as follows:
2525
- **(disable local trash)** `filen sync /local:/cloud --disable-local-trash`: Disable local trash
2626

2727
You can set the `--continuous` flag to keep syncing (instead of only syncing once).
28+
29+
Example of sync pairs registry:
30+
31+
```json
32+
[
33+
{
34+
"local": "/home/user/Pictures",
35+
"remote": "/Pictures",
36+
"syncMode": "cloudBackup"
37+
},
38+
{
39+
"local": "/home/user/Documents",
40+
"remote": "/Documents",
41+
"syncMode": "twoWay",
42+
"alias": "documents",
43+
"disableLocalTrash": true,
44+
"ignore": ["*.lnk"],
45+
"excludeDotFiles": true
46+
}
47+
]
48+
```

src/css/custom.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,8 @@ h3 {
4646
h4 {
4747
text-decoration: rgba(255, 255, 255, 0.4) wavy underline;
4848
}
49+
50+
/* tab size in listings */
51+
code {
52+
tab-size: 4;
53+
}

0 commit comments

Comments
 (0)