📚️ CLI reference

📚️ CLI reference#

Liste des commandes#

olvid-cli identity #

select current identity, (admin) manage olvid identities

olvid-cli identity [OPTIONS] COMMAND [ARGS]...

current #

get or update identity currently used for your commands

olvid-cli identity current [OPTIONS] [IDENTITY_ID]

Arguments

IDENTITY_ID#: Optional argument

get #

list identities on this daemon

olvid-cli identity get [OPTIONS] [IDENTITY_IDS]...

Options

-a, --all#

-l, --link#

-i, --identifier#

-f, --fields <fields>#

--filter <filter_>#

Arguments

IDENTITY_IDS#: Optional argument(s)

kc #

manage keycloak server for identities

olvid-cli identity kc [OPTIONS] COMMAND [ARGS]...

new#

create a new identity using a keycloak bot configuration link

olvid-cli identity kc new [OPTIONS] CONFIGURATION_LINK

Arguments

CONFIGURATION_LINK#: Required argument

key #

manage current identity Olvid api key

olvid-cli identity key [OPTIONS] COMMAND [ARGS]...

get#

get api key for current identity

olvid-cli identity key get [OPTIONS]

set#

set api key for current identity

olvid-cli identity key set [OPTIONS] APIKEY

Options

-c, --configuration#: Use a configuration link instead of a raw api key

Arguments

APIKEY#: Required argument

new #

create a new identity

olvid-cli identity new [OPTIONS] [FIRSTNAME] [LASTNAME] [POSITION] [COMPANY]

Options

-f, --first <first_opt>#: first name

-l, --last <last_opt>#: last name

-p, --position <position_opt>#: position

-c, --company <company_opt>#: company

-s, --server <server_url>#: custom server url (optional)

Arguments

FIRSTNAME#: Optional argument

LASTNAME#: Optional argument

POSITION#: Optional argument

COMPANY#: Optional argument

photo #

manage current identity photo

olvid-cli identity photo [OPTIONS] COMMAND [ARGS]...

save#

Save identity photo to local files. Specify identity_ids to use or it uses current identity id by default

⚠️ When CLI is used in a docker container mind to check the path exists inside the container.

olvid-cli identity photo save [OPTIONS] [IDENTITY_IDS]...

Options

-a, --all#: save all identity photos

-p, --path <path>#: directory to store downloaded photo (default: ./photos)

-f, --filename <filename>#: specify file name to use (ignored if saving more than one image)

Arguments

IDENTITY_IDS#: Optional argument(s)

set#

Set current identity photo.

⚠️ When CLI is used in a docker container mind to check the file exists inside the container.

olvid-cli identity photo set [OPTIONS] PHOTO_PATH

Arguments

PHOTO_PATH#: Required argument

unset#

remove current identity photo

olvid-cli identity photo unset [OPTIONS]

rm #

delete identities

olvid-cli identity rm [OPTIONS] [IDENTITY_IDS]...

Options

-a, --all#

-e, --everywhere#: delete identity on all your devices and notify contacts

Arguments

IDENTITY_IDS#: Optional argument(s)

update #

update your current identity details (name, position, …)

olvid-cli identity update [OPTIONS] [FIRSTNAME] [LASTNAME] [POSITION]
                          [COMPANY]

Options

-f, --first <first_opt>#

-l, --last <last_opt>#

-p, --position <position_opt>#

-c, --company <company_opt>#

Arguments

FIRSTNAME#: Optional argument

LASTNAME#: Optional argument

POSITION#: Optional argument

COMPANY#: Optional argument

olvid-cli key #

(admin) manage your identities client keys

olvid-cli key [OPTIONS] COMMAND [ARGS]...

get #

list existing client keys

olvid-cli key get [OPTIONS] [KEYS]...

Options

-a, --all#

-f, --fields <fields>#

--filter <filter_>#

Arguments

KEYS#: Optional argument(s)

impersonate #

connect the cli to daemon using a specific client key (necessary to access storage api)

olvid-cli key impersonate [OPTIONS] [CLIENT_KEY]

Arguments

CLIENT_KEY#: Optional argument

new #

create a new client key associated with an identity

olvid-cli key new [OPTIONS] KEY_NAME IDENTITY_ID

Arguments

KEY_NAME#: Required argument

IDENTITY_ID#: Required argument

rm #

delete a client key

olvid-cli key rm [OPTIONS] CLIENT_KEYS...

Arguments

CLIENT_KEYS#: Required argument(s)

olvid-cli discussion #

manage your discussions

olvid-cli discussion [OPTIONS] COMMAND [ARGS]...

empty #

delete all messages in a discussion

olvid-cli discussion empty [OPTIONS] DISCUSSION_IDS...

Arguments

DISCUSSION_IDS#: Required argument(s)

get #

list current identity discussions

olvid-cli discussion get [OPTIONS] [DISCUSSION_IDS]...

Options

-a, --all#

-c, --contact#

-g, --group#

-f, --fields <fields>#

--filter <filter_>#

Arguments

DISCUSSION_IDS#: Optional argument(s)

locked #

manage locked discussion

olvid-cli discussion locked [OPTIONS] COMMAND [ARGS]...

get#

list locked discussions

olvid-cli discussion locked get [OPTIONS]

Options

-f, --fields <fields>#

rm#

delete locked discussion

olvid-cli discussion locked rm [OPTIONS] DISCUSSION_IDS...

Arguments

DISCUSSION_IDS#: Required argument(s)

photo #

get discussion photos

olvid-cli discussion photo [OPTIONS] COMMAND [ARGS]...

save#

Save discussion photos to local files.

⚠️ When CLI is used in a docker container mind to check the path exists inside the container.

olvid-cli discussion photo save [OPTIONS] [DISCUSSION_IDS]...

Options

-a, --all#: Save all discussion photos

-p, --path <path>#: directory to store downloaded photo (default: ./photos)

-f, --filename <filename>#: specify file name to use (ignored if saving more than one image)

Arguments

DISCUSSION_IDS#: Optional argument(s)

olvid-cli message #

send and manage messages

olvid-cli message [OPTIONS] COMMAND [ARGS]...

get #

list current identity messages

olvid-cli message get [OPTIONS] [MESSAGE_IDS]...

Options

-d, --discussion <discussion>#: get all messages in given discussion id

-u, --unread#: get only unread messages

--filter <filter_>#

-f, --fields <fields>#

Arguments

MESSAGE_IDS#: Optional argument(s)

location #

olvid-cli message location [OPTIONS] COMMAND [ARGS]...

end#

end a location sharing message

olvid-cli message location end [OPTIONS] MESSAGE_ID

Arguments

MESSAGE_ID#: Required argument

send#

send a location message

⚠️ When CLI is used in a docker container mind to check the preview file exists inside the container.

olvid-cli message location send [OPTIONS] DISCUSSION_ID LATITUDE LONGITUDE

Options

-p, --preview <preview_file>#

--address <address>#

-a, --altitude <altitude>#

-p, --precision <precision>#

Arguments

DISCUSSION_ID#: Required argument

LATITUDE#: Required argument

LONGITUDE#: Required argument

start#

start to share a location

olvid-cli message location start [OPTIONS] DISCUSSION_ID LATITUDE LONGITUDE

Options

-a, --altitude <altitude>#

-p, --precision <precision>#

Arguments

DISCUSSION_ID#: Required argument

LATITUDE#: Required argument

LONGITUDE#: Required argument

update#

update a location sharing message

olvid-cli message location update [OPTIONS] MESSAGE_ID LATITUDE LONGITUDE

Options

-a, --altitude <altitude>#

-p, --precision <precision>#

Arguments

MESSAGE_ID#: Required argument

LATITUDE#: Required argument

LONGITUDE#: Required argument

react #

react to a given message

olvid-cli message react [OPTIONS] MESSAGE_ID [REACTION]

Arguments

MESSAGE_ID#: Required argument

REACTION#: Optional argument

refresh #

fore downloading last messages from server

olvid-cli message refresh [OPTIONS]

rm #

delete messages

olvid-cli message rm [OPTIONS] [MESSAGE_IDS]...

Options

-d, --discussion <discussion_id>#: delete all messages in given discussion id

-a, --all#: delete all messages for given identity id

-e, --everywhere#: Delete messages everywhere

--filter <filter_>#

Arguments

MESSAGE_IDS#: Optional argument(s)

send #

send text message in a given discussion

⚠️ When CLI is used in a docker container mind to check the attachment file exists inside the container.

olvid-cli message send [OPTIONS] DISCUSSION_ID [BODY]...

Options

-c, --contact#: Use passed id as a contact id

-g, --group#: Use passed id as a group id

-r, --reply <reply_id>#

-o, --once#

-e, --existence <existence_duration>#

-v, --visibility <visibility_duration>#

-a, --attachment <attachment_paths>#

Arguments

DISCUSSION_ID#: Required argument

BODY#: Optional argument(s)

update #

Update a message text body

olvid-cli message update [OPTIONS] MESSAGE_ID NEW_BODY...

Arguments

MESSAGE_ID#: Required argument

NEW_BODY#: Required argument(s)

olvid-cli call #

Manage your calls

olvid-cli call [OPTIONS] COMMAND [ARGS]...

start #

start a new call in a discussion

olvid-cli call start [OPTIONS] [CONTACT_IDS]...

Options

-d, --discussion <discussion_id>#: Use passed id as discussion id

Arguments

CONTACT_IDS#: Optional argument(s)

olvid-cli attachment #

list and save your attachments

olvid-cli attachment [OPTIONS] COMMAND [ARGS]...

get #

list current identity attachments

olvid-cli attachment get [OPTIONS] [ATTACHMENT_IDS]...

Options

-a, --all#: get attachments for current owned identity

-m, --message <message_id>#: get attachments associated to a message id

--filter <filter_>#

-f, --fields <fields>#

Arguments

ATTACHMENT_IDS#: Optional argument(s)

rm #

delete attachments

olvid-cli attachment rm [OPTIONS] ATTACHMENT_IDS...

Arguments

ATTACHMENT_IDS#: Required argument(s)

save #

download an attachment file and save it in your filesystem

⚠️ When CLI is used in a docker container mind to check the path exists inside the container.

olvid-cli attachment save [OPTIONS] ATTACHMENT_ID

Options

-p, --path <path>#: directory to store downloaded attachment

-f, --filename <filename>#: override original file name

Arguments

ATTACHMENT_ID#: Required argument

olvid-cli invitation #

send and answer invitations

olvid-cli invitation [OPTIONS] COMMAND [ARGS]...

accept #

accept an invitation

olvid-cli invitation accept [OPTIONS] INVITATION_ID

Arguments

INVITATION_ID#: Required argument

decline #

decline an invitation

olvid-cli invitation decline [OPTIONS] INVITATION_ID

Arguments

INVITATION_ID#: Required argument

get #

list current identity invitations

olvid-cli invitation get [OPTIONS] [INVITATION_IDS]...

Options

-a, --all#

-f, --fields <fields>#

--filter <filter_>#

Arguments

INVITATION_IDS#: Optional argument(s)

rm #

delete an invitation

olvid-cli invitation rm [OPTIONS] [INVITATION_IDS]...

Options

-a, --all#

Arguments

INVITATION_IDS#: Optional argument(s)

sas #

set your future contact sas code

olvid-cli invitation sas [OPTIONS] INVITATION_ID SAS_CODE

Arguments

INVITATION_ID#: Required argument

SAS_CODE#: Required argument

send #

send a new invitation using an olvid invitation url

olvid-cli invitation send [OPTIONS] INVITATION_URL

Arguments

INVITATION_URL#: Required argument

olvid-cli contact #

manage your contacts

olvid-cli contact [OPTIONS] COMMAND [ARGS]...

downgrade #

downgrade contacts and remove their one to one discussion

olvid-cli contact downgrade [OPTIONS] CONTACT_IDS...

Arguments

CONTACT_IDS#: Required argument(s)

get #

list current identity contacts

olvid-cli contact get [OPTIONS] [CONTACT_IDS]...

Options

-a, --all#

-l, --link#

-i, --identifier#

-f, --fields <fields>#

--filter <filter_>#

Arguments

CONTACT_IDS#: Optional argument(s)

introduce #

present a contact to other contacts

olvid-cli contact introduce [OPTIONS] INTRODUCED_CONTACT_ID CONTACT_IDS...

Arguments

INTRODUCED_CONTACT_ID#: Required argument

CONTACT_IDS#: Required argument(s)

invite #

invite contacts in one to one discussion

olvid-cli contact invite [OPTIONS] CONTACT_IDS...

Arguments

CONTACT_IDS#: Required argument(s)

new #

interactively add a contact

olvid-cli contact new [OPTIONS]

photo #

get contact photos

olvid-cli contact photo [OPTIONS] COMMAND [ARGS]...

save#

Save contact photos to local files.

⚠️ When CLI is used in a docker container mind to check the path exists inside the container.

olvid-cli contact photo save [OPTIONS] [CONTACT_IDS]...

Options

-a, --all#: Save all contact photos

-p, --path <path>#: directory to store downloaded photo (default: ./photos)

-f, --filename <filename>#: specify file name to use (ignored if saving more than one image)

Arguments

CONTACT_IDS#: Optional argument(s)

reset #

Recreate secure channels

olvid-cli contact reset [OPTIONS] [CONTACT_IDS]...

Options

-a, --all#: Re-create secure channels for every contact

Arguments

CONTACT_IDS#: Optional argument(s)

rm #

delete contacts

olvid-cli contact rm [OPTIONS] [CONTACT_IDS]...

Options

-a, --all#

Arguments

CONTACT_IDS#: Optional argument(s)

olvid-cli group #

manage current identity groups

olvid-cli group [OPTIONS] COMMAND [ARGS]...

admin #

manage group admins

olvid-cli group admin [OPTIONS] GROUP_ID

Options

-pa, --promote-admin <admins_to_add>#

-da, --demote-admin <admins_to_remove>#

-ppa, --pending-promote-admin <pending_admins_to_add>#

-pda, --pending-demote-admin <pending_admins_to_remove>#

Arguments

GROUP_ID#: Required argument

disband #

disband a group where you have admin permissions

olvid-cli group disband [OPTIONS] GROUP_ID

Arguments

GROUP_ID#: Required argument

get #

list current identity groups

olvid-cli group get [OPTIONS] [GROUP_IDS]...

Options

-a, --all#

-f, --fields <fields>#

--filter <filter_>#

Arguments

GROUP_IDS#: Optional argument(s)

leave #

leave a group

olvid-cli group leave [OPTIONS] GROUP_ID

Arguments

GROUP_ID#: Required argument

new #

create new groups

olvid-cli group new [OPTIONS] COMMAND [ARGS]...

advanced#

create an advanced group with custom permissions for members (not recommended)

olvid-cli group new advanced [OPTIONS] [CONTACTS_ID]...

Options

-n, --name <group_name>#

-d, --description <group_description>#

--read-only#: By default new members won’t have the send_message permission

--do-not-remote-delete#: By default do not give remote delete permission to future members

--remote-delete-admins#: By default give future admins remote delete permission

--remote-delete-everyone#: By default give future member remote delete permission

-a, --admin#: Set members as admin

-s, --send-message#: Let members send message

-e, --edit#: Let members edit or delete their messages

-r, --remote-delete#: Let members remote delete every messages

-c, --change-settings#: Let members change discussion settings

Arguments

CONTACTS_ID#: Optional argument(s)

controlled#

create a controlled group with admin and regular members

olvid-cli group new controlled [OPTIONS] [CONTACTS_ID]...

Options

-n, --name <group_name>#

-d, --description <group_description>#

-a, --admin <admin_contact_ids>#

Arguments

CONTACTS_ID#: Optional argument(s)

read-only#

create a read-only group where only admin members can post messages

olvid-cli group new read-only [OPTIONS] [CONTACTS_ID]...

Options

-n, --name <group_name>#

-d, --description <group_description>#

-a, --admin <admin_contact_ids>#

Arguments

CONTACTS_ID#: Optional argument(s)

standard#

create a standard group, where everyone have admin rights

olvid-cli group new standard [OPTIONS] [ADMIN_CONTACT_IDS]...

Options

-n, --name <group_name>#

-d, --description <group_description>#

Arguments

ADMIN_CONTACT_IDS#: Optional argument(s)

permissions #

manage a group member permissions

olvid-cli group permissions [OPTIONS] GROUP_ID CONTACT_ID

Options

-a, --admin <admin>#

-rda, --remote-delete-anything <remote_delete_anything>#

-erm, --edit-or-remote-delete-own-messages <edit_or_remote_delete_own_messages>#

-cs, --change-settings <change_settings>#

-sm, --send-message <send_message>#

Arguments

GROUP_ID#: Required argument

CONTACT_ID#: Required argument

photo #

get/update group photos

olvid-cli group photo [OPTIONS] COMMAND [ARGS]...

save#

Save group photos to local files.

⚠️ When CLI is used in a docker container mind to check the path exists inside the container.

olvid-cli group photo save [OPTIONS] [GROUP_IDS]...

Options

-a, --all#: Save all group photos

-p, --path <path>#: directory to store downloaded photo (default: ./photos)

-f, --filename <filename>#: specify file name to use (ignored if saving more than one image)

Arguments

GROUP_IDS#: Optional argument(s)

set#

Set group photo.

⚠️ When CLI is used in a docker container mind to check the file exists inside the container.

olvid-cli group photo set [OPTIONS] GROUP_ID PHOTO_PATH

Arguments

GROUP_ID#: Required argument

PHOTO_PATH#: Required argument

unset#

olvid-cli group photo unset [OPTIONS] GROUP_ID

Arguments

GROUP_ID#: Required argument

update #

update group details and/or members (advanced command)

olvid-cli group update [OPTIONS] GROUP_ID

Options

-n, --name <group_name>#

-d, --description <group_description>#

-am, --add-member <add_members>#

-aam, --add-admin-member <add_admin_members>#

-dm, --delete-member <delete_members>#

Arguments

GROUP_ID#: Required argument

olvid-cli kc #

interact with your keycloak server

olvid-cli kc [OPTIONS] COMMAND [ARGS]...

bind #

attach your current identity to a keycloak server using a keycloak bot configuration link

olvid-cli kc bind [OPTIONS] CONFIGURATION_LINK

Arguments

CONFIGURATION_LINK#: Required argument

contact #

manage keycloak contacts

olvid-cli kc contact [OPTIONS] COMMAND [ARGS]...

add#

add a keycloak user as a contact

olvid-cli kc contact add [OPTIONS] USER_ID

Arguments

USER_ID#: Required argument

get#

list keycloak users

olvid-cli kc contact get [OPTIONS]

Options

-t, --timestamp <timestamp>#: last list user timestamp

-f, --fields <fields>#

--filter <filter_>#

unbind #

remove keycloak server for current identity

olvid-cli kc unbind [OPTIONS]

olvid-cli storage #

(advanced) access a client key associated storage

olvid-cli storage [OPTIONS] COMMAND [ARGS]...

get #

olvid-cli storage get [OPTIONS] [KEYS]...

Options

-a, --all#

-d <discussion_id>#

--filter <filter_>#

-f, --fields <fields>#

Arguments

KEYS#: Optional argument(s)

reset #

Remove every entry in global and discussion storage

olvid-cli storage reset [OPTIONS]

rm #

olvid-cli storage rm [OPTIONS] [KEYS]...

Options

-a, --all#: Delete every elements in global storage

-d <discussion_id>#: Delete every elements in discussion storage

Arguments

KEYS#: Optional argument(s)

set #

olvid-cli storage set [OPTIONS] KEY VALUE

Options

-d <discussion_id>#

Arguments

KEY#: Required argument

VALUE#: Required argument

olvid-cli tools #

advanced commands to debug and manage daemon

olvid-cli tools [OPTIONS] COMMAND [ARGS]...

auto-invite #

add every other identity on this daemon as a contact

olvid-cli tools auto-invite [OPTIONS]

Options

-i, --identity <identity_id>#: Specify a specific identity to use

-f, --full#: Present every identity in the server to each other (else it only present current identity to others)

daemon-version #

show daemon version

olvid-cli tools daemon-version [OPTIONS]

listen #

listen notifications received for a specific or every notifications

olvid-cli tools listen [OPTIONS]

Options

--filter <filter_>#

-c, --count <count>#

-i, --identity <identity_id>#: Specify a specific identity to listen

-q, --quiet#: Hide notification content

-v, --verbose#: Show notification full content

-n, --notifications <notifications>#: Coma separated list of notifications to listen (upper snake case: MESSAGE_SEND,MESSAGE_RECEIVED)

olvid-cli backup #

manage your daemon backups

olvid-cli backup [OPTIONS] COMMAND [ARGS]...

get #

list backed up profiles and available snapshots

olvid-cli backup get [OPTIONS] BACKUP_KEY

Arguments

BACKUP_KEY#: Required argument

key #

manage your daemon backup key

olvid-cli backup key [OPTIONS] COMMAND [ARGS]...

get#

get current backup key (this key is common for every identity on this daemon)

olvid-cli backup key get [OPTIONS]

renew#

revoke current backup key and generate a new one

olvid-cli backup key renew [OPTIONS]

now #

start a full backup now

olvid-cli backup now [OPTIONS]

restore #

restore an entire backup on a new daemon or only specific parts

olvid-cli backup restore [OPTIONS] COMMAND [ARGS]...

admin#

restore admin backup only (admin client keys and storage)

olvid-cli backup restore admin [OPTIONS] BACKUP_KEY

Arguments

BACKUP_KEY#: Required argument

daemon#

restore an entire backup on blank daemon instance

olvid-cli backup restore daemon [OPTIONS] BACKUP_KEY

Options

-n, --device-name <device_name>#: Specify this new daemon instance name

Arguments

BACKUP_KEY#: Required argument

profile#

restore a specific profile snapshot

olvid-cli backup restore profile [OPTIONS] BACKUP_KEY SNAPSHOT_ID

Arguments

BACKUP_KEY#: Required argument

SNAPSHOT_ID#: Required argument

olvid-cli settings #

manage your settings

olvid-cli settings [OPTIONS] COMMAND [ARGS]...

discussion #

manage discussion settings

olvid-cli settings discussion [OPTIONS] COMMAND [ARGS]...

get#

olvid-cli settings discussion get [OPTIONS] DISCUSSION_ID

Options

-f, --fields <fields>#

Arguments

DISCUSSION_ID#: Required argument

set#

olvid-cli settings discussion set [OPTIONS] DISCUSSION_ID

Options

-o, --once#

-e, --existence <existence_duration>#

-v, --visibility <visibility_duration>#

Arguments

DISCUSSION_ID#: Required argument

identity #

manage identity settings

olvid-cli settings identity [OPTIONS] COMMAND [ARGS]...

invitation#

olvid-cli settings identity invitation [OPTIONS] COMMAND [ARGS]...

get#

olvid-cli settings identity invitation get [OPTIONS]

Options

-f, --fields <fields>#

set#

olvid-cli settings identity invitation set [OPTIONS]

Options

-a, --all#

-n, --none#

-i, --invitation#

-t, --introduction#

-o, --one-to-one#

-g, --group#

keycloak#

olvid-cli settings identity keycloak [OPTIONS] COMMAND [ARGS]...

get#

olvid-cli settings identity keycloak get [OPTIONS]

Options

-f, --fields <fields>#

set#

olvid-cli settings identity keycloak set [OPTIONS]

Options

--auto-invite#

message#

olvid-cli settings identity message [OPTIONS] COMMAND [ARGS]...

get#

olvid-cli settings identity message get [OPTIONS]

Options

-f, --fields <fields>#

set#

olvid-cli settings identity message set [OPTIONS]

Options

-d, --discussion-count <discussion_count>#: Set a maximum number of messages to keep in each discussion

-g, --global-count <global_count>#: Set a maximum number of messages to keep globally

-t, --duration <duration>#: Set a duration after messages are deleted (in seconds)

-l, --locked#: Delete message in locked discussions

-p, --preserve-location#: Do not delete non-finished location sharing messages

-n, --none#

📚️ CLI reference

Contents

📚️ CLI reference#

Liste des commandes#

new#

get#

set#

save#

set#

unset#

get#

rm#

save#

end#

send#

start#

update#

save#

advanced#

controlled#

read-only#

standard#

save#

set#

unset#

add#

get#

get#

renew#

admin#

daemon#

profile#

get#

set#

invitation#

get#

set#

keycloak#

get#

set#

message#

get#

set#