summaryrefslogtreecommitdiff
path: root/README.md
blob: abb3fa034f4d8548563ca749cd44c7f62ff66c53 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# iphone-notes

Create real **Apple Notes** on an iPhone from Linux by driving
[icloud.com/notes](https://www.icloud.com/notes/) with Playwright and a saved
Apple ID browser session.

Also packaged as a Cursor/Goose agent skill (`SKILL.md`) so agents can forward
prompt results to your phone as Notes.

## Quick start

```bash
./scripts/setup.sh
icloud-note login          # Apple ID + 2FA once (graphical session)
icloud-note create --title "Hello" --body "From Linux"
```

## CLI

| Command | Purpose |
|---|---|
| `icloud-note setup` | Install Playwright Chromium + `~/.local/bin` wrapper |
| `icloud-note login` | **Only** command that opens a visible browser (one-time Apple ID) |
| `icloud-note status` | Headless check that the saved session can open Notes |
| `icloud-note create` | Headless create (`--title`, `--body` / `--body-file`) — no window |

## Layout

```text
SKILL.md                 Agent instructions
scripts/icloud-note.mjs  CLI
scripts/setup.sh         One-time install + skill symlinks
tests/cli.test.sh        Smoke tests (no Apple network required)
```

Runtime config (not in git):

```text
~/.config/icloud-notes/
  storage-state.json     Cookies/session for headless create (private)
  browser-profile/       Used only during `login` (private)
  node_modules/          Playwright install
```

## Tests

```bash
./tests/cli.test.sh
```

## License

MIT