{"id":31967723,"url":"https://github.com/mathis-lambert/icloud-ignore","last_synced_at":"2025-10-14T18:41:18.393Z","repository":{"id":312764036,"uuid":"1048654382","full_name":"mathis-lambert/icloud-ignore","owner":"mathis-lambert","description":"Command-line tool to exclude folders from iCloud sync on macOS using the .nosync suffix. Simple, fast, and Homebrew-installable.","archived":false,"fork":false,"pushed_at":"2025-09-01T20:58:30.000Z","size":16,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-01T22:19:07.543Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mathis-lambert.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-01T19:57:44.000Z","updated_at":"2025-09-01T20:58:25.000Z","dependencies_parsed_at":"2025-09-01T22:29:35.640Z","dependency_job_id":null,"html_url":"https://github.com/mathis-lambert/icloud-ignore","commit_stats":null,"previous_names":["mathis-lambert/icloud-ignore"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/mathis-lambert/icloud-ignore","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathis-lambert%2Ficloud-ignore","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathis-lambert%2Ficloud-ignore/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathis-lambert%2Ficloud-ignore/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathis-lambert%2Ficloud-ignore/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mathis-lambert","download_url":"https://codeload.github.com/mathis-lambert/icloud-ignore/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathis-lambert%2Ficloud-ignore/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279020361,"owners_count":26086866,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-14T02:00:06.444Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-14T18:41:05.708Z","updated_at":"2025-10-14T18:41:18.387Z","avatar_url":"https://github.com/mathis-lambert.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# iCloud Ignore (`icignore`)\n\n`icignore` is a small command-line utility for **selectively excluding folders from iCloud synchronization** on macOS.\nIt leverages the `.nosync` suffix recognized by macOS, while keeping folder access seamless through symbolic links, so apps and Finder keep working as before.\n\n---\n\n## ✨ Features\n\n- Ignore: `icignore ignore \u003cfolder\u003e` renames to `\u003cname\u003e.nosync` and creates a symlink back.\n- Unignore: `icignore unignore \u003cfolder\u003e` removes the symlink and renames back.\n- Status: `icignore status \u003cfolder\u003e` shows symlink + real directory status.\n- Safe-by-default: refuses destructive overwrites and supports `--dry-run`.\n- Homebrew-friendly: single static binary with formula and releases.\n\n---\n\n## 🚀 Installation\n\n### Using Homebrew (macOS)\n\n```bash\nbrew tap mathis-lambert/icloud-ignore\nbrew install --cask icignore\n```\n\nUpgrade:\n\n```bash\nbrew update \u0026\u0026 brew upgrade --cask icignore\n```\n\nNote: The Homebrew cask is macOS-focused. On Linux, download the tarball from the GitHub Releases page and place `icignore` on your `PATH`.\n\n---\n\n## 🔧 Usage\n\n### Exclude a folder\n\n```bash\nicignore ignore ~/Documents/Projects\n```\n\nEffect:\n\n* The folder is renamed to `Projects.nosync` (ignored by iCloud).\n* A symbolic link `Projects` is recreated at the same location → Finder and apps continue to work as before.\n* Useful for node_modules and other transient files.\n* Avoids cluttering iCloud Drive with unnecessary files.\n\n---\n\n### Check folder status\n\n```bash\nicignore status ~/Documents/Projects\n```\n\nExample output:\n\n```\nSYMLINK: /Users/username/Documents/Projects -\u003e Projects.nosync\nREAL: /Users/username/Documents/Projects.nosync (excluded from iCloud via .nosync suffix)\n```\n\n---\n\n### Restore sync\n\n```bash\nicignore unignore ~/Documents/Projects\n```\n\nEffect:\n\n* Removes the symbolic link.\n* Renames `Projects.nosync` back to `Projects`.\n* The folder resumes syncing with iCloud.\n\n---\n\n## 🛠 Commands\n\n```\nicignore ignore \u003cpath\u003e    # Exclude a folder from iCloud sync\nicignore unignore \u003cpath\u003e  # Restore sync for a folder\nicignore status \u003cpath\u003e    # Check folder status\n```\n\nGlobal flags:\n  `--dry-run`    Print actions without changing anything\n  `--verbose`    Extra logging\n\nVersion:\n  `icignore version`\n\nExit codes: `0` on success; non-zero on error.\n\nNote: A path with or without `.nosync` is accepted for all commands.\n\n---\n\n## 🧑‍💻 Local Development\n\nPrerequisites:\n- Go 1.21+\n- Make\n\nClone and build:\n\n```bash\ngit clone https://github.com/mathis-lambert/icloud-ignore.git\ncd icloud-ignore\nmake build   # binary at bin/icignore\n```\n\nRun locally:\n\n```bash\n./bin/icignore --help\n./bin/icignore status ~/Documents/Projects\n```\n\nInstall locally:\n\n```bash\nmake install   # to /usr/local/bin or /opt/homebrew/bin\n```\n\nChecks:\n\n```bash\nmake fmt vet test\n```\n\nProject structure:\n\n```\ncmd/icignore/        # CLI entry\ninternal/icignore/   # Core operations (ignore/unignore/status)\n.github/workflows/   # Release (GoReleaser)\n```\n\n---\n\n## 📦 Release \u0026 Homebrew\n\nTagged releases are built and published via GoReleaser. The Homebrew tap repository is updated automatically.\n\n- Source repo: `mathis-lambert/icloud-ignore`\n- Tap repo: `mathis-lambert/homebrew-icloud-ignore`\n\nRelease process:\n- Merge changes to `main` and update docs.\n- Tag a version: `git tag v0.x.y \u0026\u0026 git push origin v0.x.y`\n- GitHub Actions runs GoReleaser to publish archives and update the tap.\n\nMaintainer setup (once):\n- Create a Personal Access Token (classic) with `repo` scope and add it as a secret in this repo named `HOMEBREW_TAP_TOKEN`.\n  - It must have write access to both repositories above.\n- The workflow `.github/workflows/release.yml` uses this token to publish releases and push the formula to the tap.\n\nManual release (local):\n\n```bash\nGITHUB_TOKEN=\u003cyour_pat_with_repo_scope\u003e make release\n```\n\nTap name: `mathis-lambert/icloud-ignore` (backed by repo `homebrew-icloud-ignore`).\n\n---\n\n## 🤝 Contributing\n\nContributions are welcome! See `CONTRIBUTING.md`. Please follow the `CODE_OF_CONDUCT.md`.\n\n---\n\n## 🔒 Security\n\nIf you discover a security or privacy issue, please follow `SECURITY.md` instead of filing a public issue.\n\n---\n\n## ⚖ License\n\nMIT License. See `LICENSE`.\n\n---\n\n## 💡 Quick Example\n\n```bash\n# Exclude the \"Projects\" folder in Documents\nicignore ignore ~/Documents/Projects\n\n# Verify\nicignore status ~/Documents/Projects\n```\n\nFinder will still show `Projects`, but iCloud will no longer sync it 🚫☁️.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmathis-lambert%2Ficloud-ignore","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmathis-lambert%2Ficloud-ignore","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmathis-lambert%2Ficloud-ignore/lists"}