Skip to content

docs: clarify public project overview #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jmcte merged 1 commit into from
May 16, 2026
Merged

docs: clarify public project overview #43

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# iCloud CLI

macOS command-line tools for reading iCloud-backed Apple state. The first supported command is Safari tab discovery:
macOS command-line tools for reading local iCloud-backed Apple state. The current command surface focuses on read-only local inventory:

```sh
icloud-cli safari tabs
Expand All @@ -15,7 +15,7 @@ icloud-cli drive containers --sort-by size
icloud-cli shortcuts list --name Daily
```

The initial implementation reads local Safari session and metadata property lists from `~/Library/Safari` iCloud Drive metadata from `~/Library/Mobile Documents`, and Shortcuts metadata from `~/Library/Shortcuts`. That keeps the first slice simple and testable while we map the broader iCloud/Safari sync surface. Reading live browser state may require running the terminal with Full Disk Access on macOS.
The implementation reads local Safari session and metadata property lists from `~/Library/Safari`, iCloud Drive metadata from `~/Library/Mobile Documents`, and Shortcuts metadata from `~/Library/Shortcuts`. Commands stay local and read-only while we map the broader iCloud/Safari sync surface. Reading live browser state may require running the terminal with Full Disk Access on macOS.

If Safari session files are unreadable, the command exits with an error naming the file paths it tried. If the files are readable but empty, the error says no tabs were found instead of treating it as a permissions problem.

Expand Down
Loading