Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peterbrain/icloud-nosync
Prevent a file or directory from syncing with iCloud by adding the nosync extension.
https://github.com/peterbrain/icloud-nosync
apple automator automator-workflow finder homebrew homebrew-formula icloud icloud-bypass icloud-drive icloud-sync macos macos-finder nosync
Last synced: 23 days ago
JSON representation
Prevent a file or directory from syncing with iCloud by adding the nosync extension.
- Host: GitHub
- URL: https://github.com/peterbrain/icloud-nosync
- Owner: PeterBrain
- License: mit
- Created: 2024-08-18T00:16:05.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-28T21:44:08.000Z (about 2 months ago)
- Last Synced: 2024-10-03T21:42:07.637Z (about 1 month ago)
- Topics: apple, automator, automator-workflow, finder, homebrew, homebrew-formula, icloud, icloud-bypass, icloud-drive, icloud-sync, macos, macos-finder, nosync
- Language: Shell
- Homepage:
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# iCloud noSync
[](https://github.com/PeterBrain/icloud-nosync/actions/workflows/update-tap.yml)
Prevent a file or directory from syncing with iCloud by adding the nosync extension. This process appends the nosync extension to the file or directory and then creates a symlink that points back to the original name, preserving any naming conventions (e.g.: node_modules, vendor).
Background story: iCloud can become very CPU-intensive when handling a large number of small files, such as those commonly found in `node_modules` or `vendor` folders. This is because iCloud’s synchronization process has to monitor, queue, and upload each file individually. When there are many small files, the synchronization process becomes inefficient due to overhead associated with tracking changes and managing each file's upload process.
## Features
- Prevent file or folder from syncing with iCloud
- Add to gitignore (optional)
- Undo symlink and .nosync extension
- Hide .nosync file or folder with chflags (optional)
- Non-interactive mode
- Finder quick actions
## Install
### Homebrew
```bash
brew tap peterbrain/tap
brew install icloud-nosync
cp -r /usr/local/opt/icloud-nosync/workflows/* ~/Library/Services/
```
or
```bash
brew install peterbrain/tap/icloud-nosync
cp -r /usr/local/opt/icloud-nosync/workflows/* ~/Library/Services/
```
> [!NOTE]
> Workflows for Finder Quick Actions require to be copied to `~/Library/Services` manually. This is due to a security limitation of the homebrew installer. Instructions to do so are displayed during installation.
### Manually
Clone this repository
```bash
install nosync.sh /usr/local/bin/nosync
cp -r ./workflows/* ~/Library/Services/
```
## Usage
```bash
nosync [options] [file2 ... fileN]
Options:
-v, --verbose Enable verbose output
-n, --no, --non-interactive Automatically respond no to all prompts
-y, --yes Automatically respond yes to all prompts
-u, --undo Undo symlink and .nosync extension
-x, --hidden Hide the .nosync file with chflags
-h, --help Show this help message
```
> [!NOTE]
> What happens if I want to exclude the directory or file "important", but there is already a "important.nosync" directory or file present?
>
> Answer: Nothing, this directory or file will be skipped.
> [!NOTE]
> What happens if I want to undo nosync for the directory or file "important.nosync", but there is already a "important" directory or file present?
>
> Answer: Nothing, to prevent any issues the undo process will abort. Manual conflict resolution is required.
>
> This is usually the case when the nosync file or folder gets created manually, the symlink was removed and a file or folder with the same name has taken its place.
## Caveats
- **OS**:
- Work on macOS for iCloud only.
- Minimum version is macOS Sierra 10.12.
- Other cloud services (e.g. OneDrive, Dropbox, Google Drive) are unsupported.
- **Files**:
- Files with the nosync extension wont open with their associated application anymore. Images wont be opened in preview, docs won't start Word or Pages. Avoid using nosync on files. Use it on directories whenever possible.
- **Renaming**:
- If you need to rename a file or directory with the nosync extension, you'll need to recreate the symlink. Although Finder can still locate the renamed file or directory through the old symlink, the symlink itself will continue pointing to the original location, which isn't the case in Terminal. It's recommended to delete the symlink, remove the nosync extension, and then rerun the nosync command.
- **Git**:
- If the file or folder is in a git repository and the .nosync file or extension is added to `.gitignore`, the symlink will still be tracked.
- **Undo**:
- If the symlink is provided and it does not point to the corresponding `.nosync` file, the undo process will be aborted.
- If the `.nosync` file is provided and the matching symlink (by name) does not point to it, the undo process will be aborted.
- If the `.nosync` file is provided and there is no matching symlink (e.g.: manually created), the undo process will try to restore the file.
- The undo process does not involve or modify the `.gitignore` file.
- **Quick Action**:
- Workflows require to be copied to `~/Library/Services` manually. This is due to a security limitation of the homebrew installer. Instructions to do so are displayed during install with homebrew.
- Service workflows may need to be manually enabled. Please refer to these instructions: [https://support.apple.com/guide/automator/use-quick-action-workflows-aut73234890a/mac](https://support.apple.com/guide/automator/use-quick-action-workflows-aut73234890a/mac#aut067d4e77d)
> [!CAUTION]
> The list contains only the known limitations of this program. Proceed with caution!
## Uninstall
### Homebrew
```bash
brew uninstall icloud-nosync
rm ~/Library/Services/nosync_*
```
or
```bash
brew uninstall peterbrain/tap/icloud-nosync
rm ~/Library/Services/nosync_*
```
### Manually
This is only possible if nosync was installed manually.
```bash
rm /usr/local/bin/nosync ~/Library/Services/nosync_*
```