X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/0091c1cf266de225f84d507bb473ac22582d3b15..95678354347faf961f912204479b0aefaf2162db:/man/signal-cli.1.adoc?ds=sidebyside diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc index 565909a5..e73e7cdc 100644 --- a/man/signal-cli.1.adoc +++ b/man/signal-cli.1.adoc @@ -135,14 +135,14 @@ You will need the full uri enclosed in quotation marks, such as "tsdevice:/?uuid === listDevices -Show a list of connected devices. +Show a list of linked devices. === removeDevice -Remove a connected device. +Remove a linked device. Only works, if this is the master device. -*-d* DEVICEID, *--deviceId* DEVICEID:: +*-d* DEVICE_ID, *--device-id* DEVICE_ID:: Specify the device you want to remove. Use listDevices to see the deviceIds. @@ -227,8 +227,6 @@ Don’t download attachments of received messages. === joinGroup Join a group via an invitation link. -To be able to join a v2 group the account needs to have a profile (can be created -with the `updateProfile` command) *--uri*:: The invitation link URI (starts with `https://signal.group/#`) @@ -237,8 +235,6 @@ The invitation link URI (starts with `https://signal.group/#`) Create or update a group. If the user is a pending member, this command will accept the group invitation. -To be able to join or create a v2 group the account needs to have a profile (can -be created with the `updateProfile` command) *-g* GROUP, *--group* GROUP:: Specify the recipient group ID in base64 encoding. @@ -247,12 +243,40 @@ If not specified, a new group with a new random ID is generated. *-n* NAME, *--name* NAME:: Specify the new group name. +*-d* DESCRIPTION, *--description* DESCRIPTION:: +Specify the new group description. + *-a* AVATAR, *--avatar* AVATAR:: Specify a new group avatar image file. *-m* [MEMBER [MEMBER ...]], *--member* [MEMBER [MEMBER ...]]:: Specify one or more members to add to the group. +*-r* [MEMBER [MEMBER ...]], *--remove-member* [MEMBER [MEMBER ...]]:: +Specify one or more members to remove from the group + +*--admin* [MEMBER [MEMBER ...]]:: +Specify one or more members to make a group admin + +*--remove-admin* [MEMBER [MEMBER ...]]:: +Specify one or more members to remove group admin privileges + +*--reset-link*:: +Reset group link and create new link password + +*--link* LINK_STATE:: +Set group link state: `enabled`, `enabled-with-approval`, `disabled` + +*--set-permission-add-member* PERMISSION:: +Set permission to add new group members: `every-member`, `only-admins` + +*--set-permission-edit-details* PERMISSION:: +Set permission to edit group details: `every-member`, `only-admins` + +*-e* EXPIRATION_SECONDS, *--expiration* EXPIRATION_SECONDS:: +Set expiration time of messages (seconds). +To disable expiration set expiration time to 0. + === quitGroup Send a quit group message to all group members and remove self from member list. @@ -269,6 +293,10 @@ In json mode this is outputted as an list of objects and is always in detailed m *-d*, *--detailed*:: Include the list of members of each group and the group invite link. +=== listContacts + +Show a list of known contacts with names. + === listIdentities List all known identity keys and their trust status, fingerprint and safety number. @@ -293,18 +321,28 @@ Specify the safety number of the key, only use this option if you have verified === updateProfile -Update the name and avatar image visible by message recipients for the current users. +Update the profile information shown to message recipients. The profile is stored encrypted on the Signal servers. -The decryption key is sent with every outgoing messages to contacts. +The decryption key is sent with every outgoing messages to contacts and included +in every group. + +*--given-name* NAME, *--name* NAME:: +New (given) name. + +*--family-name* FAMILY_NAME:: +New family name. -*--name*:: -New name visible by message recipients. +*--about* ABOUT_TEXT:: +New profile status text. -*--avatar*:: -Path to the new avatar visible by message recipients. +*--about-emoji* EMOJI:: +New profile status emoji. + +*--avatar* AVATAR_FILE:: +Path to the new avatar image file. *--remove-avatar*:: -Remove the avatar visible by message recipients. +Remove the avatar === updateContact @@ -318,7 +356,7 @@ Specify the contact phone number. *-n*, *--name*:: Specify the new name for this contact. -*-e*, *--expiration*:: +*-e*, *--expiration* EXPIRATION_SECONDS:: Set expiration time of messages (seconds). To disable expiration set expiration time to 0. @@ -349,6 +387,12 @@ Specify the group IDs that should be unblocked in base64 encoding. Send a synchronization message with the local contacts list to all linked devices. This command should only be used if this is the master device. +=== sendSyncRequest + +Send a synchronization request message to the master device (for group, contacts, ...). +The master device will respond with synchronization messages with full contact and +group lists. + === uploadStickerPack Upload a new sticker pack, consisting of a manifest file and the stickers in WebP format (maximum size for a sticker file is 100KiB). @@ -407,6 +451,9 @@ signal-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]] Add member to a group:: signal-cli -u USERNAME updateGroup -g GROUP_ID -m "NEW_MEMBER" +Accept a group invitation:: +signal-cli -u USERNAME updateGroup -g GROUP_ID + Leave a group:: signal-cli -u USERNAME quitGroup -g GROUP_ID