@roman-16/proton-cli-win32-x64 1.11.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -33
- package/bin/proton-cli.exe +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,23 +8,21 @@
|
|
|
8
8
|
|
|
9
9
|
_Unofficial, community-built, not affiliated with Proton AG._
|
|
10
10
|
|
|
11
|
-
[](https://github.com/roman-16/proton-cli/releases/latest)
|
|
12
|
-
[](https://github.com/roman-16/proton-cli/releases)
|
|
13
|
-
[](https://github.com/roman-16/proton-cli/blob/main/docs/installation.md)
|
|
14
|
-
[](https://github.com/roman-16/proton-cli/blob/main/LICENSE)
|
|
11
|
+
[](https://github.com/roman-16/proton-cli/releases/latest) [](https://github.com/roman-16/proton-cli/releases) [](https://github.com/roman-16/proton-cli/blob/main/docs/installation.md) [](https://github.com/roman-16/proton-cli/blob/main/LICENSE)
|
|
15
12
|
|
|
16
13
|
<picture>
|
|
17
14
|
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/roman-16/proton-cli/main/assets/demo-dark.svg">
|
|
18
|
-
<img src="https://raw.githubusercontent.com/roman-16/proton-cli/main/assets/demo-light.svg" alt="Listing unread mail,
|
|
15
|
+
<img src="https://raw.githubusercontent.com/roman-16/proton-cli/main/assets/demo-light.svg" alt="Listing unread mail, uploading a file to Drive, previewing which files a cleanup would remove, and listing Pass items">
|
|
19
16
|
</picture>
|
|
20
17
|
|
|
21
18
|
</div>
|
|
19
|
+
<br />
|
|
22
20
|
|
|
23
21
|
Read your mail, move files in and out of Drive, manage calendars, passwords, and contacts, all without opening a browser. proton-cli logs in the way the Proton apps do and does the encryption on your machine, so your keys stay yours.
|
|
24
22
|
|
|
25
23
|
- **Real end-to-end encryption.** SRP login and the full PGP key hierarchy, handled locally with Proton's own [go-srp](https://github.com/ProtonMail/go-srp) and [gopenpgp](https://github.com/ProtonMail/gopenpgp). No bridge, no proxy, no browser in the middle.
|
|
26
24
|
- **Five apps, one binary.** Mail, Drive, Calendar, Pass, and Contacts, in a single static executable on Linux, macOS, and Windows.
|
|
27
|
-
- **Built for pipes and cron.** JSON and YAML
|
|
25
|
+
- **Built for pipes and cron.** JSON and YAML with one envelope shape for every list, streaming stdin and stdout, exit codes that mean something, and `--dry-run` on everything that changes state, showing the rows it would touch.
|
|
28
26
|
|
|
29
27
|
## Install
|
|
30
28
|
|
|
@@ -44,42 +42,44 @@ Already installed? `proton-cli update`.
|
|
|
44
42
|
|
|
45
43
|
## Get started
|
|
46
44
|
|
|
47
|
-
|
|
45
|
+
```console
|
|
46
|
+
$ proton-cli account login
|
|
47
|
+
Email: you@proton.me
|
|
48
|
+
Password:
|
|
49
|
+
Two-factor code: 123456
|
|
48
50
|
|
|
49
|
-
|
|
50
|
-
export PROTON_USER=you@proton.me
|
|
51
|
-
export PROTON_PASSWORD='your-password'
|
|
52
|
-
# export PROTON_TOTP=123456 # only if two-factor is enabled
|
|
51
|
+
✓ Signed in as you@proton.me.
|
|
53
52
|
```
|
|
54
53
|
|
|
55
|
-
|
|
54
|
+
That's the whole setup. Signing in saves the session **and** unlocks your keys, so your password is needed once on this machine and not again. Every command documents itself with `--help`:
|
|
56
55
|
|
|
57
56
|
```bash
|
|
58
57
|
proton-cli mail messages list
|
|
58
|
+
proton-cli mail messages send --help
|
|
59
59
|
```
|
|
60
60
|
|
|
61
|
-
|
|
61
|
+
Scripting it? `proton-cli account login --user you@proton.me --password-file /run/secrets/proton` needs no terminal. Juggling a personal and a work account? `proton-cli account login --profile work`. More in [Getting started](https://github.com/roman-16/proton-cli/blob/main/docs/getting-started.md).
|
|
62
62
|
|
|
63
63
|
## What you can do
|
|
64
64
|
|
|
65
|
-
|
|
65
|
+
Every command reads the same way - `proton-cli <app> <collection> <verb>` - and anywhere one wants an ID, a subject, name, or URL works too. Lists shorten IDs to 8 characters you can paste straight back. See [The language](https://github.com/roman-16/proton-cli/blob/main/docs/language.md).
|
|
66
66
|
|
|
67
67
|
### Mail
|
|
68
68
|
|
|
69
69
|
```bash
|
|
70
70
|
proton-cli mail messages list --unread
|
|
71
71
|
proton-cli mail messages search --from billing@example.com --after 2026-01-01
|
|
72
|
-
proton-cli mail messages
|
|
73
|
-
proton-cli mail messages send --to alice@proton.me --subject Report
|
|
74
|
-
--body "See attached." --attach ./report.pdf
|
|
72
|
+
proton-cli mail messages get "Invoice #2291"
|
|
73
|
+
proton-cli mail messages send --to alice@proton.me --subject Report --body "See attached." --attach ./report.pdf
|
|
75
74
|
proton-cli mail messages reply "Invoice #2291" --body "Thanks, paid today."
|
|
76
75
|
proton-cli mail messages forward "Invoice #2291" --to alice@proton.me
|
|
77
76
|
proton-cli mail drafts create --to team@example.com --subject Standup --body "Notes to follow."
|
|
77
|
+
proton-cli mail messages label "Invoice #2291" --label Accounting
|
|
78
78
|
proton-cli mail messages export --folder archive --older-than 1y --output-dir ./backup
|
|
79
79
|
proton-cli mail messages trash --unread --older-than 30d
|
|
80
80
|
```
|
|
81
81
|
|
|
82
|
-
Threads,
|
|
82
|
+
Threads, attachments, filters, and auto-reply. → [Mail](https://github.com/roman-16/proton-cli/blob/main/docs/commands/mail.md)
|
|
83
83
|
|
|
84
84
|
### Drive
|
|
85
85
|
|
|
@@ -87,48 +87,58 @@ Threads, drafts, attachments, `.eml` export, folders, labels, Sieve filters, sig
|
|
|
87
87
|
proton-cli drive items list /Documents
|
|
88
88
|
proton-cli drive items upload --recursive ./project /Backup
|
|
89
89
|
proton-cli drive items download /Documents/report.pdf --output-dir .
|
|
90
|
+
proton-cli drive items move /Documents/report.pdf --into /Archive
|
|
90
91
|
proton-cli drive share link /Documents/report.pdf --expires 7d --password hunter2
|
|
91
92
|
proton-cli drive items trash --pattern "*.tmp" --scope /Build --recursive
|
|
92
93
|
```
|
|
93
94
|
|
|
94
|
-
|
|
95
|
+
Revisions, sharing with people, and photo albums. → [Drive](https://github.com/roman-16/proton-cli/blob/main/docs/commands/drive.md)
|
|
95
96
|
|
|
96
97
|
### Calendar
|
|
97
98
|
|
|
98
99
|
```bash
|
|
99
100
|
proton-cli calendar events list --start 2026-04-15 --end 2026-04-30
|
|
100
101
|
proton-cli calendar events create --title Dentist --start 2026-04-16T14:00 --duration 1h
|
|
101
|
-
proton-cli calendar events create --title Standup --start 2026-04-16T09:00
|
|
102
|
-
--duration 15m --rrule "FREQ=WEEKLY;COUNT=10" --remind 15m
|
|
102
|
+
proton-cli calendar events create --title Standup --start 2026-04-16T09:00 --duration 15m --rrule "FREQ=WEEKLY;COUNT=10" --remind 15m
|
|
103
103
|
proton-cli calendar events respond "Team sync" --status accept
|
|
104
104
|
```
|
|
105
105
|
|
|
106
|
-
|
|
106
|
+
Your own calendars, all-day events, and attendees. → [Calendar](https://github.com/roman-16/proton-cli/blob/main/docs/commands/calendar.md)
|
|
107
107
|
|
|
108
108
|
### Pass
|
|
109
109
|
|
|
110
110
|
```bash
|
|
111
111
|
proton-cli pass items list --vault Work
|
|
112
112
|
proton-cli pass items get github.com
|
|
113
|
-
proton-cli pass items create --name GitHub --username roman
|
|
114
|
-
|
|
115
|
-
proton-cli pass alias create --prefix shop --mailbox me@proton.me
|
|
113
|
+
proton-cli pass items create --name GitHub --username roman --password "$(openssl rand -base64 24)" --url github.com
|
|
114
|
+
proton-cli pass aliases create --prefix shop --mailbox me@proton.me
|
|
116
115
|
```
|
|
117
116
|
|
|
118
|
-
|
|
117
|
+
Notes, cards, SSH keys, and identities. → [Pass](https://github.com/roman-16/proton-cli/blob/main/docs/commands/pass.md)
|
|
119
118
|
|
|
120
119
|
### Contacts
|
|
121
120
|
|
|
122
121
|
```bash
|
|
123
122
|
proton-cli contacts list
|
|
124
123
|
proton-cli contacts create --name "Jane Roe" --email jane@example.com
|
|
125
|
-
proton-cli contacts pin
|
|
124
|
+
proton-cli contacts keys pin jane --key jane-pubkey.asc
|
|
126
125
|
proton-cli contacts groups add GROUP_ID jane
|
|
127
126
|
```
|
|
128
127
|
|
|
129
|
-
|
|
128
|
+
Multiple addresses, organizations, and birthdays. → [Contacts](https://github.com/roman-16/proton-cli/blob/main/docs/commands/contacts.md)
|
|
129
|
+
|
|
130
|
+
### Account
|
|
130
131
|
|
|
131
|
-
|
|
132
|
+
```bash
|
|
133
|
+
proton-cli account get
|
|
134
|
+
proton-cli account sessions list
|
|
135
|
+
proton-cli account settings set locale de_AT
|
|
136
|
+
proton-cli account logout --revoke
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
Profiles and per-app settings. → [Account](https://github.com/roman-16/proton-cli/blob/main/docs/commands/account.md)
|
|
140
|
+
|
|
141
|
+
[`proton-cli api`](https://github.com/roman-16/proton-cli/blob/main/docs/commands/api.md) reaches any endpoint the commands don't.
|
|
132
142
|
|
|
133
143
|
## Automate it
|
|
134
144
|
|
|
@@ -136,8 +146,9 @@ Groups, several addresses per contact, and details like organization and birthda
|
|
|
136
146
|
# creating something prints its new ID to stdout
|
|
137
147
|
ID=$(proton-cli mail settings labels create --name Work --color "#8080FF")
|
|
138
148
|
|
|
139
|
-
#
|
|
149
|
+
# every list is an envelope keyed by its plural name, always with a count
|
|
140
150
|
proton-cli mail messages list --unread --output json | jq -r '.messages[].subject'
|
|
151
|
+
proton-cli drive items list /Backup --output json | jq '[.items[].size] | add'
|
|
141
152
|
|
|
142
153
|
# stream through, no temporary files
|
|
143
154
|
pg_dump mydb | gzip | proton-cli drive items upload - /Backups/db.sql.gz
|
|
@@ -151,6 +162,8 @@ proton-cli mail messages trash --from newsletter@example.com --older-than 90d --
|
|
|
151
162
|
|
|
152
163
|
Data goes to stdout and progress to stderr, so redirects stay clean. Exit codes tell user error, auth failure, not-found, ambiguity, and network trouble apart, so scripts can react to each. → [Scripting](https://github.com/roman-16/proton-cli/blob/main/docs/scripting.md)
|
|
153
164
|
|
|
165
|
+
Anything that removes permanently, or that removes what a filter picked out rather than what you named, shows the rows and asks first. Off a terminal it refuses instead, so an unattended run fails safe until you add `--yes`. → [When it asks first](https://github.com/roman-16/proton-cli/blob/main/docs/language.md#when-it-asks-first)
|
|
166
|
+
|
|
154
167
|
## Encryption you can verify
|
|
155
168
|
|
|
156
169
|
Your password never reaches Proton: login is SRP, and the key password it derives stays local and unlocks your PGP keys in memory. Mail, files, events, contacts, and Pass items are decrypted after they arrive and encrypted before they leave, with the same key hierarchy the web clients use. Signatures on incoming mail are checked and reported.
|
|
@@ -165,8 +178,11 @@ Everything lives in [`docs/`](https://github.com/roman-16/proton-cli/blob/main/d
|
|
|
165
178
|
| --- | --- |
|
|
166
179
|
| [Installation](https://github.com/roman-16/proton-cli/blob/main/docs/installation.md) | Every platform, updating, uninstalling |
|
|
167
180
|
| [Configuration](https://github.com/roman-16/proton-cli/blob/main/docs/configuration.md) | Credentials, profiles, environment variables |
|
|
168
|
-
| [
|
|
169
|
-
|
|
|
181
|
+
| [Getting started](https://github.com/roman-16/proton-cli/blob/main/docs/getting-started.md) | Signing in, completion, profiles |
|
|
182
|
+
| [The language](https://github.com/roman-16/proton-cli/blob/main/docs/language.md) | The grammar: apps, collections, verbs, filters |
|
|
183
|
+
| [Output](https://github.com/roman-16/proton-cli/blob/main/docs/output.md) | The four response kinds, JSON, colour, exit codes |
|
|
184
|
+
| [References](https://github.com/roman-16/proton-cli/blob/main/docs/references.md) | Names, short IDs, compound IDs |
|
|
185
|
+
| **Command reference** | [Everything](https://github.com/roman-16/proton-cli/blob/main/docs/commands/README.md) · [Mail](https://github.com/roman-16/proton-cli/blob/main/docs/commands/mail.md) · [Drive](https://github.com/roman-16/proton-cli/blob/main/docs/commands/drive.md) · [Calendar](https://github.com/roman-16/proton-cli/blob/main/docs/commands/calendar.md) · [Pass](https://github.com/roman-16/proton-cli/blob/main/docs/commands/pass.md) · [Contacts](https://github.com/roman-16/proton-cli/blob/main/docs/commands/contacts.md) · [Account](https://github.com/roman-16/proton-cli/blob/main/docs/commands/account.md) · [API](https://github.com/roman-16/proton-cli/blob/main/docs/commands/api.md) |
|
|
170
186
|
| [Scripting](https://github.com/roman-16/proton-cli/blob/main/docs/scripting.md) | Pipelines, `jq`, cron and systemd |
|
|
171
187
|
| [How it works](https://github.com/roman-16/proton-cli/blob/main/docs/how-it-works.md) | Login, keys, what's encrypted with what |
|
|
172
188
|
| [Limitations](https://github.com/roman-16/proton-cli/blob/main/docs/limitations.md) | Platform constraints and gaps |
|
|
@@ -175,7 +191,8 @@ Everything lives in [`docs/`](https://github.com/roman-16/proton-cli/blob/main/d
|
|
|
175
191
|
|
|
176
192
|
- **Search lags a few seconds.** Proton's index is eventually consistent, so act on the ID a command printed rather than searching for the same subject again.
|
|
177
193
|
- **CAPTCHAs need a desktop.** Proton occasionally asks for human verification at login, which opens a small window. On a headless machine, log in elsewhere and copy the session. See [Human verification](https://github.com/roman-16/proton-cli/blob/main/docs/human-verification.md).
|
|
178
|
-
- **Colors are Proton's.** Labels, folders, calendars, and groups accept only the 20 accent colors; an invalid `--color` prints the
|
|
194
|
+
- **Colors are Proton's.** Labels, folders, calendars, and groups accept only the 20 accent colors; an invalid `--color` prints the whole palette.
|
|
195
|
+
- **Folders and labels are different.** A message lives in one folder and carries any number of labels, so `move --into` and `label --label` are separate verbs.
|
|
179
196
|
|
|
180
197
|
## Contributing
|
|
181
198
|
|
package/bin/proton-cli.exe
CHANGED
|
Binary file
|