Skip to content
proton-cli

All commands

Every command in one table, generated from the command tree. Search this page for a word, then follow the link for the arguments, flags and examples.

proton <app> <collection> <verb> [TARGET...] [--flags]

Where a command shows REF, pass a full ID, the eight-character short ID a list printed, or something you already know: a subject, a name, a path, an email address. See Naming what to act on.

Command What it does
proton account delete Delete the account and everything in it
proton account get Show the account, its storage and this machine’s session
proton account login Sign in and save the session for this profile
proton account logout Discard the saved session for this profile
proton account breaches disable Turn Dark Web Monitoring off
proton account breaches enable Turn Dark Web Monitoring on
proton account breaches get Show one breach, and what it exposed
proton account breaches list List the breaches Proton found your addresses in
proton account breaches reopen Mark resolved breaches as open again
proton account breaches resolve Mark breaches as resolved
proton account keys create Generate a key for an address
proton account keys delete Delete keys of an address
proton account keys export Write keys out to files
proton account keys get Show one key and what it is used for
proton account keys import Add keys to an address from files
proton account keys list List the keys of the account and its addresses
proton account keys reactivate Bring back the keys a password reset locked
proton account keys update Make a key primary, or mark it obsolete or compromised
proton account profiles delete Remove a profile and everything it keeps on this machine
proton account profiles list List the profiles with a saved session
proton account security-log delete Remove every event the log holds
proton account security-log disable Stop recording sign-ins and credential changes
proton account security-log enable Record sign-ins and credential changes
proton account security-log get Show what is being recorded, and how much of it there is
proton account security-log list List what Proton recorded, newest first
proton account sessions create Sign another device in from this one
proton account sessions list List every signed-in session
proton account sessions revoke Invalidate sessions at Proton
proton account settings emergency-access access Sign in to an account whose emergency access is open
proton account settings emergency-access add Let somebody into your account in an emergency
proton account settings emergency-access cancel Take back a request in flight
proton account settings emergency-access get Show one emergency access
proton account settings emergency-access grant Let a pending request in now, without the wait
proton account settings emergency-access list List the people you let into your account
proton account settings emergency-access remove Remove an emergency contact
proton account settings emergency-access request Start the wait to get into an account that granted you access
proton account settings emergency-access update Change how long an emergency contact waits
proton account settings get Show the account settings now in effect
proton account settings list List the account settings that can be changed
proton account settings notifications disable Stop emails or notices Proton sends you
proton account settings notifications enable Have Proton send you emails or notices
proton account settings notifications list List what Proton sends you, and what is on
proton account settings password set Change your password
proton account settings recovery-contacts add Let somebody help you recover your account
proton account settings recovery-contacts get Show one recovery contact
proton account settings recovery-contacts list List the people who can help you recover
proton account settings recovery-contacts remove Remove a recovery contact
proton account settings recovery-email disable Stop allowing password resets by email
proton account settings recovery-email enable Allow password resets by email
proton account settings recovery-email get Show the recovery address and what it may do
proton account settings recovery-email set Set the recovery address
proton account settings recovery-email verify Send a verification email to the recovery address
proton account settings recovery-phone disable Stop allowing password resets by SMS
proton account settings recovery-phone enable Allow password resets by SMS
proton account settings recovery-phone get Show the recovery number and what it may do
proton account settings recovery-phone set Set the recovery number
proton account settings recovery-phone verify Confirm the recovery number with a code sent by SMS
proton account settings recovery-phrase disable Remove the recovery phrase
proton account settings recovery-phrase get Show whether a recovery phrase is set
proton account settings recovery-phrase set Make a recovery phrase and print it
proton account settings second-password disable Leave two-password mode
proton account settings second-password enable Lock your keys with a second password
proton account settings second-password get Show whether this account uses two-password mode
proton account settings second-password set Change your second password
proton account settings security-keys create Register a security key with the account
proton account settings security-keys delete Remove a security key from the account
proton account settings security-keys list List the security keys registered with the account
proton account settings security-keys update Rename a security key
proton account settings sentinel disable Turn Proton Sentinel off
proton account settings sentinel enable Turn Proton Sentinel on
proton account settings sentinel get Show whether Proton Sentinel is on
proton account settings set Change one account setting
proton account settings two-factor disable Stop asking for an authenticator app code
proton account settings two-factor enable Ask for an authenticator app code at every sign-in
proton account settings two-factor generate Make a two-factor secret for an authenticator app
proton account settings two-factor get Show what this account is asked for at sign-in
proton api Send a raw authenticated request to the Proton API
proton calendar booking-pages create Make a booking page and print its link
proton calendar booking-pages delete Delete booking pages
proton calendar booking-pages get Show one booking page, link and all
proton calendar booking-pages list List your booking pages
proton calendar booking-pages update Change what a booking page offers
proton calendar busy-times list List when people are busy in a date range
proton calendar events create Create an event
proton calendar events delete Delete events
proton calendar events export Write events out as an .ics file
proton calendar events get Show one event, decrypted
proton calendar events import Read events in from an .ics file
proton calendar events list List events in a date range
proton calendar events respond Answer an invitation, telling the organizer
proton calendar events update Change an event’s title, time, location, description or recurrence
proton calendar invitations accept Take a calendar somebody offered you
proton calendar invitations decline Turn down a calendar somebody offered you
proton calendar invitations list List calendars other people have offered you
proton calendar reminders list List the reminders due in a date range
proton calendar reminders watch Print each reminder as it comes due
proton calendar settings calendars create Create a calendar, subscribe to one, or add public holidays
proton calendar settings calendars delete Delete calendars, and every event in them
proton calendar settings calendars get Show one calendar, with the defaults it gives new events
proton calendar settings calendars leave Leave calendars somebody shared with you
proton calendar settings calendars list List your calendars
proton calendar settings calendars share add Give somebody a calendar
proton calendar settings calendars share get Show who has a calendar
proton calendar settings calendars share remove Take somebody’s access to a calendar away
proton calendar settings calendars share update Change what somebody may do with a calendar
proton calendar settings calendars update Rename or recolor a calendar, or change what it gives new events
proton calendar settings get Show the calendar settings now in effect
proton calendar settings holidays list List the public holidays calendars you can add
proton calendar settings links create Publish a calendar as a link anyone can follow
proton calendar settings links get Show one link, URL and all
proton calendar settings links list List the links you have published
proton calendar settings links revoke Stop a link working
proton calendar settings links update Rename a link
proton calendar settings list List the calendar settings that can be changed
proton calendar settings set Change one calendar setting
proton contacts create Create a contact
proton contacts delete Delete contacts
proton contacts export Write contacts out as vCards
proton contacts get Show one contact in full
proton contacts import Read contacts in from a .vcf file
proton contacts list List contacts
proton contacts merge Fold duplicate contacts into one
proton contacts update Change a contact’s details
proton contacts emails list List a contact’s addresses and how mail to each is sent
proton contacts emails update Change how mail to an address is sent
proton contacts groups add Add contacts to a group
proton contacts groups create Create a contact group
proton contacts groups delete Delete contact groups
proton contacts groups get Show one group and the addresses in it
proton contacts groups list List contact groups
proton contacts groups remove Remove contacts from a group
proton contacts groups update Rename or recolor a contact group
proton contacts keys list List the keys you trust for a contact
proton contacts keys trust Trust a public key so mail to a contact is encrypted to it
proton contacts keys untrust Stop trusting a contact’s keys
proton drive computers delete Remove computers from Drive
proton drive computers list List the computers syncing to Drive
proton drive computers update Rename a computer
proton drive invitations abuse Report what an invitation offers to Proton
proton drive invitations accept Accept invitations
proton drive invitations decline Decline invitations
proton drive invitations list List invitations waiting for an answer
proton drive items abuse Report something shared with you to Proton
proton drive items copy Copy files into another folder
proton drive items create Create a folder, and any missing folder above it
proton drive items delete Delete files or folders permanently
proton drive items download Download a file or folder
proton drive items get Show a file or folder’s details
proton drive items list List what is in a folder
proton drive items move Move files or folders into another folder
proton drive items revisions abuse Report an earlier version of a shared file to Proton
proton drive items revisions delete Delete an earlier version permanently
proton drive items revisions download Download an earlier version of a file
proton drive items revisions list List a file’s earlier versions
proton drive items revisions restore Restore a file to an earlier version
proton drive items share add Invite someone to a file or folder
proton drive items share confirm Let somebody in once they join Proton
proton drive items share get Show how a file or folder is shared
proton drive items share remove Revoke someone’s access, or cancel their invitation
proton drive items share resend Send an unanswered invitation again
proton drive items share update Change what somebody may do with a file or folder
proton drive items trash Move files or folders to the trash
proton drive items update Rename a file or folder
proton drive items upload Upload a file or directory
proton drive links create Make a link that opens a file or folder for anyone
proton drive links get Show the link on a file or folder, URL and all
proton drive links list List the links you have made
proton drive links revoke Stop the link on a file or folder working
proton drive photos albums add Put photos into an album
proton drive photos albums create Create an album
proton drive photos albums delete Delete albums
proton drive photos albums list List albums
proton drive photos albums remove Take photos out of an album
proton drive photos albums share add Invite someone to an album
proton drive photos albums share confirm Let somebody in once they join Proton
proton drive photos albums share get Show how an album is shared
proton drive photos albums share remove Revoke someone’s access, or cancel their invitation
proton drive photos albums share resend Send an unanswered invitation again
proton drive photos albums share update Change what somebody may do with an album
proton drive photos albums update Rename an album, or change its cover
proton drive photos delete Delete photos permanently
proton drive photos download Download a photo
proton drive photos favorite Mark photos as favourites
proton drive photos links create Make a link that opens a photo for anyone
proton drive photos links get Show the link on a photo, URL and all
proton drive photos links revoke Stop the link on a photo working
proton drive photos list List photos
proton drive photos share add Invite someone to a photo
proton drive photos share confirm Let somebody in once they join Proton
proton drive photos share get Show how a photo is shared
proton drive photos share remove Revoke someone’s access, or cancel their invitation
proton drive photos share resend Send an unanswered invitation again
proton drive photos share update Change what somebody may do with a photo
proton drive photos trash Move photos to the trash
proton drive photos unfavorite Remove photos from favourites
proton drive photos upload Upload a photo to the library
proton drive settings get Show the drive settings now in effect
proton drive settings list List the drive settings that can be changed
proton drive settings set Change one drive setting
proton drive shared add Add a public link to what is shared with you
proton drive shared leave Give up an item somebody shared with you
proton drive shared list List what other people have shared with you
proton drive shared remove Forget a public link you saved
proton drive sharing list List what you have shared with other people
proton drive trash empty Delete everything in the trash, permanently
proton drive trash list List what is in the trash
proton drive trash restore Put items back where they came from
proton drive volumes delete Delete a locked volume and everything on it
proton drive volumes list List the volumes your files and photos are kept on
proton drive volumes restore Put the files of a locked volume back
proton index create Index an app so its contents can be searched
proton index delete Remove an index from this machine
proton index list List what is indexed on this machine
proton index update Bring every index up to date
proton index watch Keep every index current until you stop it
proton mail conversations attachments download Download and decrypt attachments from a thread
proton mail conversations attachments list List every attachment in a thread
proton mail conversations count Count the threads in each folder and label
proton mail conversations delete Delete threads permanently
proton mail conversations export Write a whole thread out as .eml files or one mbox
proton mail conversations forward Forward the newest message in a thread
proton mail conversations get Show a whole thread, decrypted
proton mail conversations label Attach a label to threads
proton mail conversations list List threads in a folder
proton mail conversations mark read Mark threads as read
proton mail conversations mark unread Mark threads as unread
proton mail conversations move Move threads to a folder
proton mail conversations reply Reply to the newest message in a thread
proton mail conversations snooze Take threads out of the inbox until later
proton mail conversations star Star threads
proton mail conversations trash Move threads to the trash
proton mail conversations unlabel Detach a label from threads
proton mail conversations unsnooze Bring snoozed threads back to the inbox now
proton mail conversations unstar Remove the star from threads
proton mail conversations update Change when threads delete themselves
proton mail drafts create Save a draft without sending it
proton mail drafts delete Delete drafts
proton mail drafts list List drafts
proton mail drafts send Send a draft as it stands
proton mail drafts update Change a draft’s recipients, subject, body or attachments
proton mail mailing-lists get Show one mailing list in full
proton mail mailing-lists list List the senders that write to you as a list
proton mail mailing-lists remove Drop a mailing list from the listing
proton mail mailing-lists unsubscribe Ask a mailing list to stop writing to you
proton mail mailing-lists update Set what happens to a mailing list’s mail
proton mail messages attachments download Download and decrypt attachments
proton mail messages attachments list List a message’s attachments
proton mail messages count Count the messages in each folder and label
proton mail messages delete Delete messages permanently
proton mail messages empty Delete everything in a folder, permanently
proton mail messages export Write messages out as .eml or mbox files
proton mail messages forward Forward a message
proton mail messages get Show one message, decrypted
proton mail messages label Attach a label to messages
proton mail messages list List messages in a folder
proton mail messages mark legitimate Mark a message Proton flagged as legitimate
proton mail messages mark phishing Report a message to Proton as phishing
proton mail messages mark read Mark messages as read
proton mail messages mark unread Mark messages as unread
proton mail messages move Move messages to a folder
proton mail messages receipt Tell the sender you read their message
proton mail messages reply Reply to a message
proton mail messages send Compose and send a message
proton mail messages star Star messages
proton mail messages trackers list List the trackers blocked in a message
proton mail messages trash Move messages to the trash
proton mail messages unlabel Detach a label from messages
proton mail messages unschedule Cancel a scheduled send, returning the message to drafts
proton mail messages unstar Remove the star from messages
proton mail messages unsubscribe Ask the mailing list a message came from to stop
proton mail messages update Change when messages delete themselves
proton mail messages watch Print each message as it arrives
proton mail protected attachments download Download and decrypt attachments
proton mail protected attachments list List a password-protected message’s attachments
proton mail protected get Show a password-protected message, decrypted
proton mail protected reply Reply to a password-protected message
proton mail settings addresses create Add an address to the account
proton mail settings addresses delete Delete addresses
proton mail settings addresses disable Stop an address sending and receiving
proton mail settings addresses enable Let a disabled address send and receive again
proton mail settings addresses get Show one address, including its signature
proton mail settings addresses list List the addresses on the account
proton mail settings addresses reorder Make an address the default, or set their order
proton mail settings addresses update Set an address’s display name or signature
proton mail settings autoreply disable Turn the auto-reply off, keeping its schedule
proton mail settings autoreply enable Turn the auto-reply on, keeping its schedule
proton mail settings autoreply get Show the auto-reply and its schedule
proton mail settings autoreply set Configure the auto-reply and turn it on
proton mail settings categories disable Hide categories from the inbox
proton mail settings categories enable Show categories as tabs in the inbox
proton mail settings categories list List the categories, and which show and notify
proton mail settings categories update Change whether a category notifies
proton mail settings domains create Add a custom domain to the account
proton mail settings domains delete Remove a custom domain
proton mail settings domains get Show a domain’s DNS entries and their status
proton mail settings domains list List the custom domains on the account
proton mail settings domains update Set the address that catches stray mail
proton mail settings filters apply Run filters over mail that is already in the mailbox
proton mail settings filters create Create a filter
proton mail settings filters delete Delete filters
proton mail settings filters disable Disable filters
proton mail settings filters enable Enable filters
proton mail settings filters get Show what a filter matches and does
proton mail settings filters list List your filters
proton mail settings filters reorder Set the order filters run in
proton mail settings filters update Change what a filter is called, matches, or does
proton mail settings folders create Create a folder
proton mail settings folders delete Delete folders
proton mail settings folders list List your folders
proton mail settings folders reorder Set the order your folders are kept in
proton mail settings folders update Rename a folder, recolor it, or move it
proton mail settings forwarding accept Accept forwardings sent to you
proton mail settings forwarding create Forward one of your addresses to another address
proton mail settings forwarding decline Decline forwardings sent to you
proton mail settings forwarding delete Stop forwardings, in either direction
proton mail settings forwarding disable Pause forwardings without taking them down
proton mail settings forwarding enable Resume paused forwardings
proton mail settings forwarding get Show one forwarding
proton mail settings forwarding list List forwardings in both directions
proton mail settings forwarding resend Ask the forwardee again
proton mail settings get Show the mail settings now in effect
proton mail settings imports cancel Stop an import that is running
proton mail settings imports create Bring another mailbox in over IMAP
proton mail settings imports delete Forget the record of a finished import
proton mail settings imports get Show one import, folder by folder
proton mail settings imports list List the imports on the account
proton mail settings imports resume Set a stopped import going again
proton mail settings imports undo Take back everything an import brought in
proton mail settings labels create Create a label
proton mail settings labels delete Delete labels
proton mail settings labels list List your labels
proton mail settings labels reorder Set the order your labels are kept in
proton mail settings labels update Rename or recolor a label
proton mail settings list List the mail settings that can be changed
proton mail settings senders allow Always let someone reach the inbox
proton mail settings senders block Send someone’s mail straight to blocked
proton mail settings senders list List every standing decision about a sender
proton mail settings senders remove Drop a standing decision, letting the spam filter decide again
proton mail settings senders spam Send someone’s mail straight to spam
proton mail settings set Change one mail setting
proton mail settings smtp-tokens create Make a token for a device to send with
proton mail settings smtp-tokens delete Stop a token working
proton mail settings smtp-tokens get Show a token and where the device it is for connects
proton mail settings smtp-tokens list List the tokens on the account
proton pass aliases contacts allow Let a contact’s mail reach you again
proton pass aliases contacts block Stop a contact’s mail reaching you
proton pass aliases contacts create Make an address that writes to somebody as the alias
proton pass aliases contacts delete Remove an address an alias can write to
proton pass aliases contacts list List the addresses an alias can write to
proton pass aliases create Create an alias
proton pass aliases disable Stop receiving mail sent to an alias
proton pass aliases enable Start receiving mail sent to an alias
proton pass aliases list List your aliases
proton pass breaches create Have Proton watch an address you own elsewhere
proton pass breaches delete Stop Proton watching an address you added
proton pass breaches disable Stop Proton watching an address
proton pass breaches enable Have Proton watch an address again
proton pass breaches get Show the breaches one address has appeared in
proton pass breaches list List the addresses Proton watches, and how many breaches each is in
proton pass breaches resend Send the confirmation code again
proton pass breaches resolve Mark an address’s current breaches as resolved
proton pass breaches verify Confirm an address with the code Proton emailed it
proton pass invitations accept Take what somebody offered you
proton pass invitations decline Turn down what somebody offered you
proton pass invitations list List what other people have offered you
proton pass items attachments download Download and decrypt attachments
proton pass items attachments list List an item’s attachments
proton pass items attachments restore Put a removed attachment back on an item
proton pass items attachments update Rename an attachment
proton pass items create Create an item
proton pass items delete Delete items permanently
proton pass items exclude Leave logins out of Pass Monitor’s checks
proton pass items get Show one item, decrypted
proton pass items include Bring logins back into Pass Monitor’s checks
proton pass items list List items across your vaults
proton pass items move Put an item in another vault
proton pass items passkeys list List the passkeys stored against a login
proton pass items passkeys remove Take a passkey off a login
proton pass items pin Keep items at the top of the list
proton pass items revisions get Show one earlier version, decrypted
proton pass items revisions list Show what an item used to be
proton pass items revisions restore Put an item back to an earlier version
proton pass items share add Offer one item to somebody
proton pass items share confirm Let somebody into an item once they join Proton
proton pass items share get Show how an item is shared
proton pass items share remove Take somebody’s access to an item away
proton pass items share update Change what somebody may do with an item
proton pass items totp Print the current two-factor code for an item
proton pass items trash Move items to the trash
proton pass items unpin Stop keeping items at the top
proton pass items update Change an item’s fields
proton pass links create Make a link that shows one item
proton pass links get Show one link, URL and all
proton pass links list List the links you have made
proton pass links revoke Stop a link working
proton pass export Write the vaults you own out to a file
proton pass generate Make a password
proton pass import Read items in from a password manager’s export
proton pass settings access-tokens activity list List what a token has done
proton pass settings access-tokens create Make a token for a program to use
proton pass settings access-tokens delete Stop a token working
proton pass settings access-tokens get Show a token and the vaults it reads
proton pass settings access-tokens list List the tokens, expired ones included
proton pass settings access-tokens update Change which vaults a token reads
proton pass settings domains create Add a domain of your own for aliases
proton pass settings domains delete Remove a domain of your own
proton pass settings domains get Show a domain, with the DNS entries a custom one needs
proton pass settings domains list List the domains an alias can be made on
proton pass settings domains update Change a domain: the default, catch-all or names
proton pass settings extra-password disable Remove the extra password from Pass
proton pass settings extra-password enable Protect Pass with an extra password
proton pass settings extra-password get Show whether Pass has an extra password
proton pass settings mailboxes create Add an address for aliases to forward to
proton pass settings mailboxes delete Remove an address aliases forward to
proton pass settings mailboxes list List the addresses your aliases forward to
proton pass settings mailboxes resend Send the confirmation code again
proton pass settings mailboxes update Change a mailbox
proton pass settings mailboxes verify Confirm an address with the code Proton emailed it
proton pass shared list List the items other people have shared with you
proton pass sharing list List the items you have shared
proton pass trash empty Delete everything in the trash, permanently
proton pass trash list List what is in the trash
proton pass trash restore Put items back where they came from
proton pass vaults create Create a vault
proton pass vaults delete Delete vaults, and everything in them
proton pass vaults get Show one vault in full
proton pass vaults hide Keep vaults out of your listings
proton pass vaults list List your vaults
proton pass vaults share add Offer a vault to somebody
proton pass vaults share confirm Let somebody into a vault once they join Proton
proton pass vaults share get Show who can open a vault
proton pass vaults share remove Take somebody’s access to a vault away
proton pass vaults share update Change what somebody may do with a vault
proton pass vaults transfer Make somebody else the owner of a vault
proton pass vaults unhide Bring hidden vaults back into your listings
proton pass vaults update Rename a vault, or change how it looks
proton changelog Print what each release changed
proton completion Generate a shell completion script
proton report Collect what a bug report needs
proton skill Print the skill that teaches an AI agent to use proton
proton uninstall Remove a curl/PowerShell-installed proton
proton update Update proton to the latest release
proton version Print the version and build information

These are declared on the root, so any command takes them and they mean the same thing everywhere.

Flag Description
--config string Settings file to read (env: PROTON_CONFIG; default: config.yaml in the config directory)
--confirm string Which commands stop for a yes: default, deletions, mutations, reads, all (env: PROTON_CONFIRM)
-n, --dry-run Preview mutations without applying them
--force-color Force colored output, even when piped (env: FORCE_COLOR)
--full-ids Show full IDs in interactive output (default: shortened to 8 chars on TTY)
--log-level string Logging verbosity: debug, info, warn, error (env: PROTON_LOG_LEVEL)
--no-color Disable colored output (env: NO_COLOR)
--no-input Never prompt; a missing credential becomes an error (env: PROTON_NO_INPUT)
--no-log Write no diagnostic log for this run (env: PROTON_NO_LOG)
-o, --output string Output format: text, json, yaml (default “text”)
-p, --profile string Profile to act as (env: PROTON_PROFILE; default: default)
-q, --quiet Suppress non-essential stderr output
--verified string A human verification already solved, as the refusal printed it (env: PROTON_VERIFIED)
-y, --yes Answer confirmation prompts with yes
--zone string IANA time zone to work in (env: TZ; default: your system zone)

See Settings, files and environment for what each one changes, and Output and exit codes for what a command answers with.