X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/b7f05a1c806c37a044ce21f87e72598fcd342bb3..07893546d0058440c315d582dd573e1c02639355:/man/signal-cli.1.adoc?ds=sidebyside diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc index 03d9ffaf..a821d2a8 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. @@ -199,6 +199,20 @@ Specify the timestamp of the message to which to react. *-r*, *--remove*:: Remove a reaction. +=== sendTyping + +Send typing message to trigger a typing indicator for the recipient. +Indicator will be shown for 15seconds unless a typing STOP message is sent first. + +RECIPIENT:: +Specify the recipients’ phone number. + +*-g* GROUP, *--group* GROUP:: +Specify the recipient group ID in base64 encoding. + +*-s*, *--stop*:: +Send a typing STOP message. + === remoteDelete Remotely delete a previously sent message. @@ -243,12 +257,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. @@ -257,6 +299,9 @@ If the user is a pending member, this command will decline the group invitation. *-g* GROUP, *--group* GROUP:: Specify the recipient group ID in base64 encoding. +*--delete*:: +Delete local group data completely after quitting group. + === listGroups Show a list of known groups and related information. @@ -265,6 +310,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. @@ -324,7 +373,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. @@ -355,9 +404,21 @@ 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). +Upload a new sticker pack, consisting of a manifest file and the sticker images. +Images must conform to the following specification: (see https://support.signal.org/hc/en-us/articles/360031836512-Stickers#sticker_reqs ) +- Static stickers in PNG or WebP format +- Animated stickers in APNG format, +- Maximum file size for a sticker file is 300KiB +- Image resolution of 512 x 512 px + The required manifest.json has the following format: [source,json] @@ -366,12 +427,14 @@ The required manifest.json has the following format: "title": "", "author": "", "cover": { // Optional cover, by default the first sticker is used as cover - "file": "", + "file": "", + "contentType": "", "emoji": "" }, "stickers": [ { - "file": "", + "file": "", + "contentType": "", "emoji": "" } ... @@ -413,6 +476,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