Skip to content

Latest commit

 

History

History
55 lines (43 loc) · 2.6 KB

README.md

File metadata and controls

55 lines (43 loc) · 2.6 KB

Documentation

Rendered and searchable at proton-cli.lerchster.dev.

Start here

Page What it covers
Install Every platform, updating, uninstalling
First commands Signing in, your first commands, completion
How a command is built The grammar and the verbs

The apps

One guide each, task by task, with the reference for that app beside it.

App What it covers
Mail Reading, sending, searching, organizing, filters, auto-reply
Drive Upload and download, revisions, sharing, public links, trash, photos
Calendar Events, recurrence, reminders, invitations, busy times, booking pages, .ics
Pass Items, vaults, aliases, secure links, two-factor codes
Meet Meetings, rooms, your personal room, and their links
Contacts Contacts, groups, trusted keys, vCard import and export
Account Signing in, sessions, several accounts side by side, settings
Local index Searching inside messages, from an encrypted copy on this machine
Raw API Reaching an endpoint the commands do not cover

Everyday use

Page What it covers
Naming what to act on IDs, short IDs, names, paths
Filters and bulk changes Acting on many things at once
Dry runs and confirmations Previewing a change, and what asks first
Output and exit codes The five response shapes, JSON, colour, exit codes
Scripting Pipelines, jq, cron and systemd
AI agents The skill an agent reads, and fencing what it may do
Settings, files and environment The config file, variables, global flags

When something goes wrong

Page What it covers
Troubleshooting CAPTCHAs, expired sessions, rate limits
What it can't do Known gaps, and what to do instead

About

Page What it covers
FAQ Is this official? How does it differ from Bridge? Is my password safe?
Security What leaves your machine, what is on disk, how to reduce your risk
All commands Every command in one table
proton itself Updating, uninstalling, completions, changelog