]> nmode's Git Repositories - signal-cli/blob - man/signal-cli.1.adoc
Cache newly created session record
[signal-cli] / man / signal-cli.1.adoc
1 /////
2 vim:set ts=4 sw=4 tw=82 noet:
3 /////
4
5 :quotes.~:
6
7 = signal-cli (1)
8 :doctype: manpage
9
10 == Name
11
12 signal-cli - A commandline interface for the Signal messenger
13
14 == Synopsis
15
16 *signal-cli* [--config CONFIG] [-h | -v | -a ACCOUNT | --dbus | --dbus-system] command [command-options]
17
18 == Description
19
20 signal-cli is a commandline interface for libsignal-service-java.
21 It supports registering, verifying, sending and receiving messages.
22 For registering you need a phone number where you can receive SMS or incoming calls.
23 signal-cli was primarily developed to be used on servers to notify admins of important events.
24 For this use-case, it has a dbus and a JSON-RPC interface, that can be used to send messages from other programs.
25
26 For some functionality the Signal protocol requires that all messages have been received from the server.
27 The `receive` command should be regularly executed.
28 In daemon mode messages are by default continuously received.
29
30 == Options
31
32 *-h*, *--help*::
33 Show help message and quit.
34
35 *--version*::
36 Print the version and quit.
37
38 *-v*, *--verbose*::
39 Raise log level and include lib signal logs.
40
41 *--log-file* LOG_FILE::
42 Write log output to the given file.
43 If `--verbose` is also given, the detailed logs will only be written to the log file.
44
45 *--scrub-log*::
46 Scrub possibly sensitive information from the log, like phone numbers and UUIDs.
47 Doesn't work reliably on dbus logs with very verbose logging (`-vvv`)
48
49 *--config* CONFIG::
50 Set the path, where to store the config.
51 Make sure you have full read/write access to the given directory.
52 (Default: `$XDG_DATA_HOME/signal-cli` (`$HOME/.local/share/signal-cli`))
53
54 *-a* ACCOUNT, *--account* ACCOUNT::
55 Specify your phone number, that will be your identifier.
56 The phone number must include the country calling code, i.e. the number must start with a "+" sign.
57
58 This flag must not be given for the `link` command.
59 It is optional for the `daemon` command.
60 For all other commands it is only optional if there is exactly one local user in the config directory.
61
62 *--service-environment* ENVIRONMENT::
63 Choose the server environment to use:
64
65 - `live` (default)
66 - `staging`
67
68 *--dbus*::
69 Make request via user dbus.
70
71 *--dbus-system*::
72 Make request via system dbus.
73
74 *--bus-name*::
75 Connect to another D-Bus bus name than the default.
76
77 *-o* OUTPUT-MODE, *--output* OUTPUT-MODE::
78 Specify if you want commands to output in either "plain-text" mode or in "json".
79 Defaults to "plain-text"
80
81 *--trust-new-identities* TRUST-MODE::
82 Choose when to trust new identities:
83 - `on-first-use` (default): Trust the first seen identity key from new users, changed keys must be verified manually
84 - `always`: Trust any new identity key without verification
85 - `never`: Don't trust any unknown identity key, every key must be verified manually
86
87 *--disable-send-log*::
88 Disable message send log (for resending messages that recipient couldn't decrypt).
89
90 == Commands
91
92 === register
93
94 Register a phone number with SMS or voice verification.
95 Use the verify command to complete the verification.
96
97 If the account is just deactivated, the register command will just reactivate account, without requiring an SMS verification.
98 By default the unregister command just deactivates the account, in which case it can be reactivated without sms verification if the local data is still available.
99 If the account was deleted (with --delete-account) it cannot be reactivated.
100
101 *-v*, *--voice*::
102 The verification should be done over voice, not SMS.
103 Voice verification only works if an SMS verification has been attempted before.
104
105 *--captcha* CAPTCHA::
106 The captcha token, required if registration failed with a captcha required error.
107 To get the token, go to https://signalcaptchas.org/registration/generate.html
108 For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html
109 After solving the captcha, right-click on the "Open Signal" link and copy the link.
110
111 *--reregister*::
112 Register even if account is already registered.
113
114 === verify
115
116 Verify the number using the code received via SMS or voice.
117
118 VERIFICATIONCODE::
119 The verification code.
120
121 *-p* PIN, *--pin* PIN::
122 The registration lock PIN, that was set by the user.
123 Only required if a PIN was set.
124
125 === unregister
126
127 Disable push support for this device, i.e. this device won't receive any more messages.
128 If this is the primary device, other users can't send messages to this number anymore.
129 Use "updateAccount" to undo this.
130 To remove a linked device, use "removeDevice" from the primary device.
131
132 *--delete-account*::
133 Delete account completely from server.
134 Cannot be undone without loss.
135 You will have to be readded to each group.
136
137 CAUTION: Only delete your account if you won't use this number again!
138
139 === deleteLocalAccountData
140
141 Delete all local data for this account.
142 Data should only be deleted if the account is unregistered.
143
144 CAUTION: This cannot be undone.
145
146 *--ignore-registered*::
147 Delete the account data even though the account is still registered on the Signal servers.
148
149 === updateAccount
150
151 Update the account attributes on the signal server.
152 Can fix problems with receiving messages.
153
154 *-n* NAME, *--device-name* NAME::
155 Set a new device name for the primary or linked device
156
157 *-u* NAME *--username* NAME::
158 Specify a username that can then be used to contact this account.
159 This can either be just the nickname (e.g. test) or the complete username with discriminator (e.g. test.000).
160 Returns the new username with discriminator and the username link.
161
162 *--delete-username*::
163 Delete the username associated with this account.
164
165 *--unrestricted-unidentified-sender* {true,false}::
166 Enable if anyone should be able to send you unidentified sender messages.
167
168 *--discoverable-by-number* {true,false}::
169 Enable/disable if the account should be discoverable by phone number
170
171 *--number-sharing* {true,false}::
172 Indicates if Signal should share its phone number when sending a message.
173
174 === startChangeNumber
175
176 Change an account to a new phone number with SMS or voice verification.
177 Use the finishChangeNumber command to complete the verification.
178
179 NUMBER::
180 The new phone number.
181
182 *-v*, *--voice*::
183 The verification should be done over voice, not SMS.
184 Voice verification only works if an SMS verification has been attempted before.
185
186 *--captcha*::
187 The captcha token, required if registration failed with a captcha required error.
188 To get the token, go to https://signalcaptchas.org/registration/generate.html
189 For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html
190 After solving the captcha, right-click on the "Open Signal" link and copy the link.
191
192 === finishChangeNumber
193
194 Verify the number using the code received via SMS or voice.
195
196 NUMBER::
197 The new phone number.
198
199 *-v*, *--verification-code*::
200 The verification code.
201
202 *-p* PIN, *--pin* PIN::
203 The registration lock PIN, that was set by the user.
204 Only required if a PIN was set.
205
206 === updateConfiguration
207
208 Update signal configs and sync them to linked devices.
209 This command only works on the primary devices.
210
211 *--read-receipts* {true,false}::
212 Indicates if Signal should send read receipts.
213
214 *--unidentified-delivery-indicators* {true,false}::
215 Indicates if Signal should show unidentified delivery indicators.
216
217 *--typing-indicators* {true,false}::
218 Indicates if Signal should send/show typing indicators.
219
220 *--link-previews* {true,false}::
221 Indicates if Signal should generate link previews.
222
223 === setPin
224
225 Set a registration lock pin, to prevent others from registering this number.
226
227 REGISTRATION_LOCK_PIN::
228 The registration lock PIN, that will be required for new registrations (resets after 7 days of inactivity)
229
230 === removePin
231
232 Remove the registration lock pin.
233
234 === link
235
236 Link to an existing device, instead of registering a new number.
237 This shows a "sgnl://linkdevice?uuid=..." URI.
238 If you want to connect to another signal-cli instance, you can just use this URI.
239 If you want to link to an Android/iOS device, create a QR code with the URI (e.g. with qrencode) and scan that in the Signal app.
240
241 *-n* NAME, *--name* NAME::
242 Optionally specify a name to describe this new device.
243 By default "cli" will be used.
244
245 === addDevice
246
247 Link another device to this device.
248 Only works, if this is the primary device.
249
250 *--uri* URI::
251 Specify the uri contained in the QR code shown by the new device.
252 You will need the full URI such as "sgnl://linkdevice?uuid=..." (formerly "tsdevice:/?uuid=...") Make sure to enclose it in quotation marks for shells.
253
254 === listDevices
255
256 Show a list of linked devices.
257
258 === removeDevice
259
260 Remove a linked device.
261 Only works, if this is the primary device.
262
263 *-d* DEVICE_ID, *--device-id* DEVICE_ID::
264 Specify the device you want to remove.
265 Use listDevices to see the deviceIds.
266
267 === getUserStatus
268
269 Uses a list of phone numbers or usernames to determine the statuses of those users.
270 Shows if they are registered on the Signal Servers or not.
271 In json mode this is outputted as a list of objects.
272
273 [NUMBER [NUMBER ...]]::
274 One or more numbers to check.
275
276 [--username [USERNAME ...]]::
277 One or more usernames to check.
278
279 === send
280
281 Send a message to another user or group.
282
283 RECIPIENT::
284 Specify the recipients’ phone number.
285
286 *--note-to-self*::
287 Send the message to self without notification.
288
289 *-g* GROUP, *--group-id* GROUP::
290 Specify the recipient group ID in base64 encoding.
291
292 *-u* USERNAME, *--username* USERNAME::
293 Specify the recipient username or username link.
294
295 *-m* MESSAGE, *--message* MESSAGE::
296 Specify the message.
297
298 *--message-from-stdin*::
299 Read the message from standard input.
300
301 *-a* [ATTACHMENT [ATTACHMENT ...]], *--attachment* [ATTACHMENT [ATTACHMENT ...]]::
302 Add one or more files as attachment.
303 Can be either a file path or a data URI.
304 Data URI encoded attachments must follow the RFC 2397.
305 Additionally a file name can be added:
306 e.g.: `data:<MIME-TYPE>;filename=<FILENAME>;base64,<BASE64 ENCODED DATA>`
307
308 *--sticker* STICKER::
309 Send a sticker of a locally known sticker pack (syntax: stickerPackId:stickerId).
310 Shouldn't be used together with `-m` as the official clients don't support this.
311 e.g.: `--sticker 00abac3bc18d7f599bff2325dc306d43:2`
312
313 *--mention*::
314 Mention another group member (syntax: start:length:recipientNumber) In the apps the mention replaces part of the message text, which is specified by the start and length values.
315 The units of start and length should be UTF-16 code units, NOT Unicode code points. For more information, see https://github.com/AsamK/signal-cli/wiki/FAQ#string-indexing-units
316 e.g.: `-m "Hi X!" --mention "3:1:+123456789"`
317
318 *--text-style*::
319 Style parts of the message text (syntax: start:length:STYLE). Like `--mention`, the units are UTF-16 code units.
320 Where STYLE is one of: BOLD, ITALIC, SPOILER, STRIKETHROUGH, MONOSPACE
321
322 e.g.: `-m "Something BIG!" --text-style "10:3:BOLD"` or for a mixed text style `-m "Something BIG!" --text-style "0:9:ITALIC" "10:3:BOLD"`
323
324 *--quote-timestamp*::
325 Specify the timestamp of a previous message with the recipient or group to add a quote to the new message.
326
327 *--quote-author*::
328 Specify the number of the author of the original message.
329
330 *--quote-message*::
331 Specify the message of the original message.
332
333 *--quote-mention*::
334 Specify the mentions of the original message (same format as `--mention`).
335
336 *--quote-text-style*::
337 Style parts of the original message text (same format as `--text-style`).
338
339 *--quote-attachment*::
340 Specify the attachments of the original message (syntax: contentType[:filename[:previewFile]]), e.g. 'audio/aac' or 'image/png:test.png:/tmp/preview.jpg'.
341
342 *--preview-url*::
343 Specify the url for the link preview.
344 The same url must also appear in the message body, otherwise the preview won't be displayed by the apps.
345
346 *--preview-title*::
347 Specify the title for the link preview (mandatory).
348
349 *--preview-description*::
350 Specify the description for the link preview (optional).
351
352 *--preview-image*::
353 Specify the image file for the link preview (optional).
354
355 *--story-timestamp*::
356 Specify the timestamp of a story to reply to.
357
358 *--story-author*::
359 Specify the number of the author of the story.
360
361 *-e*, *--end-session*::
362 Clear session state and send end session message.
363
364 *--edit-timestamp*::
365 Specify the timestamp of a previous message with the recipient or group to send an edited message.
366
367 === sendMessageRequestResponse
368
369 Send response to a message request to linked devices.
370
371 RECIPIENT::
372 Specify the recipients’ phone number.
373
374 *-g* GROUP, *--group-id* GROUP::
375 Specify the recipient group ID in base64 encoding.
376
377 *-u* USERNAME, *--username* USERNAME::
378 Specify the recipient username or username link.
379
380 *--type* TYPE::
381 Type of message request response (accept, delete)
382
383 === sendPaymentNotification
384
385 Send a payment notification.
386
387 RECIPIENT::
388 Specify the recipient’s phone number.
389
390 *--receipt* RECEIPT::
391 The base64 encoded receipt blob.
392
393 *--note* NOTE::
394 Specify a note for the payment notification.
395
396 === sendReaction
397
398 Send reaction to a previously received or sent message.
399
400 RECIPIENT::
401 Specify the recipients’ phone number.
402
403 *-g* GROUP, *--group-id* GROUP::
404 Specify the recipient group ID in base64 encoding.
405
406 *-u* USERNAME, *--username* USERNAME::
407 Specify the recipient username or username link.
408
409 *-e* EMOJI, *--emoji* EMOJI::
410 Specify the emoji, should be a single unicode grapheme cluster.
411
412 *-a* NUMBER, *--target-author* NUMBER::
413 Specify the number of the author of the message to which to react.
414
415 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
416 Specify the timestamp of the message to which to react.
417
418 *-r*, *--remove*::
419 Remove a reaction.
420
421 *--story*::
422 React to a story instead of a normal message
423
424 === sendReceipt
425
426 Send a read or viewed receipt to a previously received message.
427
428 RECIPIENT::
429 Specify the sender’s phone number.
430
431 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
432 Specify the timestamp of the message to which to react.
433
434 *--type* TYPE::
435 Specify the receipt type, either `read` (the default) or `viewed`.
436
437 === sendTyping
438
439 Send typing message to trigger a typing indicator for the recipient.
440 Indicator will be shown for 15seconds unless a typing STOP message is sent first.
441
442 RECIPIENT::
443 Specify the recipients’ phone number.
444
445 *-g* GROUP, *--group-id* GROUP::
446 Specify the recipient group ID in base64 encoding.
447
448 *-s*, *--stop*::
449 Send a typing STOP message.
450
451 === remoteDelete
452
453 Remotely delete a previously sent message.
454
455 RECIPIENT::
456 Specify the recipients’ phone number.
457
458 *-g* GROUP, *--group-id* GROUP::
459 Specify the recipient group ID in base64 encoding.
460
461 *-u* USERNAME, *--username* USERNAME::
462 Specify the recipient username or username link.
463
464 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
465 Specify the timestamp of the message to delete.
466
467 === receive
468
469 Query the server for new messages.
470 New messages are printed on standard output and attachments are downloaded to the config directory.
471 In json mode this is outputted as one json object per line.
472
473 *-t* TIMEOUT, *--timeout* TIMEOUT::
474 Number of seconds to wait for new messages (negative values disable timeout).
475 Default is 5 seconds.
476
477 *--max-messages*::
478 Maximum number of messages to receive, before returning.
479
480 *--ignore-attachments*::
481 Don’t download attachments of received messages.
482
483 *--ignore-stories*::
484 Don’t receive story messages from the server.
485
486
487 *--send-read-receipts*::
488 Send read receipts for all incoming data messages (in addition to the default delivery receipts)
489
490 === joinGroup
491
492 Join a group via an invitation link.
493
494 *--uri*::
495 The invitation link URI (starts with `https://signal.group/#`)
496
497 === updateGroup
498
499 Create or update a group.
500 If the user is a pending member, this command will accept the group invitation.
501
502 *-g* GROUP, *--group-id* GROUP::
503 Specify the recipient group ID in base64 encoding.
504 If not specified, a new group with a new random ID is generated.
505
506 *-n* NAME, *--name* NAME::
507 Specify the new group name.
508
509 *-d* DESCRIPTION, *--description* DESCRIPTION::
510 Specify the new group description.
511
512 *-a* AVATAR, *--avatar* AVATAR::
513 Specify a new group avatar image file.
514
515 *-m* [MEMBER [MEMBER ...]], *--member* [MEMBER [MEMBER ...]]::
516 Specify one or more members to add to the group.
517
518 *-r* [MEMBER [MEMBER ...]], *--remove-member* [MEMBER [MEMBER ...]]::
519 Specify one or more members to remove from the group
520
521 *--admin* [MEMBER [MEMBER ...]]::
522 Specify one or more members to make a group admin
523
524 *--remove-admin* [MEMBER [MEMBER ...]]::
525 Specify one or more members to remove group admin privileges
526
527 *--ban* [MEMBER [MEMBER ...]]::
528 Specify one or more members to ban from joining the group.
529 Banned members cannot join or request to join via a group link.
530
531 *--unban* [MEMBER [MEMBER ...]]::
532 Specify one or more members to remove from the ban list
533
534 *--reset-link*::
535 Reset group link and create new link password
536
537 *--link* LINK_STATE::
538 Set group link state: `enabled`, `enabled-with-approval`, `disabled`
539
540 *--set-permission-add-member* PERMISSION::
541 Set permission to add new group members: `every-member`, `only-admins`
542
543 *--set-permission-edit-details* PERMISSION::
544 Set permission to edit group details: `every-member`, `only-admins`
545
546 *--set-permission-send-messages* PERMISSION::
547 Set permission to send messages in group: `every-member`, `only-admins`
548 Groups where only admins can send messages are also called announcement groups
549
550 *-e* EXPIRATION_SECONDS, *--expiration* EXPIRATION_SECONDS::
551 Set expiration time of messages (seconds).
552 To disable expiration set expiration time to 0.
553
554 === quitGroup
555
556 Send a quit group message to all group members and remove self from member list.
557 If the user is a pending member, this command will decline the group invitation.
558
559 *-g* GROUP, *--group-id* GROUP::
560 Specify the recipient group ID in base64 encoding.
561
562 *--delete*::
563 Delete local group data completely after quitting group.
564
565 === listGroups
566
567 Show a list of known groups and related information.
568 In json mode this is outputted as an list of objects and is always in detailed mode.
569
570 *-d*, *--detailed*::
571 Include the list of members of each group and the group invite link.
572
573 *-g*, *--group-id*::
574 Filter the group list by one or more group IDs.
575
576 === listContacts
577
578 Show a list of known contacts with names and profiles.
579 When a specific recipient is given, its profile will be refreshed.
580
581 RECIPIENT::
582 Specify the recipients’ phone number.
583
584 *-a*, *--all-recipients*::
585 Include all known recipients, not only contacts.
586
587 *--blocked*::
588 Specify if only blocked or unblocked contacts should be shown (default: all contacts)
589
590 *--name*::
591 Find contacts with the given contact or profile name.
592
593 === listIdentities
594
595 List all known identity keys and their trust status, fingerprint and safety number.
596
597 *-n* NUMBER, *--number* NUMBER::
598 Only show identity keys for the given phone number.
599
600 === trust
601
602 Set the trust level of a given number.
603 The first time a key for a number is seen, it is trusted by default (TOFU).
604 If the key changes, the new key must be trusted manually.
605
606 number::
607 Specify the phone number, for which to set the trust.
608
609 *-a*, *--trust-all-known-keys*::
610 Trust all known keys of this user, only use this for testing.
611
612 *-v* VERIFIED_SAFETY_NUMBER, *--verified-safety-number* VERIFIED_SAFETY_NUMBER::
613 Specify the safety number of the key, only use this option if you have verified the safety number.
614 Can be either the plain text numbers shown in the app or the bytes from the QR-code, encoded as base64.
615
616 === updateProfile
617
618 Update the profile information shown to message recipients.
619 The profile is stored encrypted on the Signal servers.
620 The decryption key is sent with every outgoing messages to contacts and included in every group.
621
622 *--given-name* NAME, *--name* NAME::
623 New (given) name.
624
625 *--family-name* FAMILY_NAME::
626 New family name.
627
628 *--about* ABOUT_TEXT::
629 New profile status text.
630
631 *--about-emoji* EMOJI::
632 New profile status emoji.
633
634 *--avatar* AVATAR_FILE::
635 Path to the new avatar image file.
636
637 *--remove-avatar*::
638 Remove the avatar
639
640 *--mobile-coin-address*::
641 New MobileCoin address (Base64 encoded public address)
642
643 === updateContact
644
645 Update the info associated to a number on our contact list.
646 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
647 If the contact doesn't exist yet, it will be added.
648
649 NUMBER::
650 Specify the contact phone number.
651
652 *--given-name* NAME, *--name* NAME::
653 New (given) name.
654
655 *--family-name* FAMILY_NAME::
656 New family name.
657
658 *-e*, *--expiration* EXPIRATION_SECONDS::
659 Set expiration time of messages (seconds).
660 To disable expiration set expiration time to 0.
661
662 === removeContact
663
664 Remove the info of a given contact
665
666 NUMBER::
667 Specify the contact phone number.
668
669 *--hide*::
670 Hide the contact in the contact list, but keep the data.
671
672 *--forget*::
673 Delete all data associated with this contact, including identity keys and sessions.
674
675 === block
676
677 Block the given contacts or groups (no messages will be received).
678 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
679
680 [CONTACT [CONTACT ...]]::
681 Specify the phone numbers of contacts that should be blocked.
682
683 *-g* [GROUP [GROUP ...]], *--group-id* [GROUP [GROUP ...]]::
684 Specify the group IDs that should be blocked in base64 encoding.
685
686 === unblock
687
688 Unblock the given contacts or groups (messages will be received again).
689 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
690
691 [CONTACT [CONTACT ...]]::
692 Specify the phone numbers of contacts that should be unblocked.
693
694 *-g* [GROUP [GROUP ...]], *--group-id* [GROUP [GROUP ...]]::
695 Specify the group IDs that should be unblocked in base64 encoding.
696
697 === sendContacts
698
699 Send a synchronization message with the local contacts list to all linked devices.
700 This command should only be used if this is the primary device.
701
702 === sendSyncRequest
703
704 Send a synchronization request message to the primary device (for group, contacts, ...).
705 The primary device will respond with synchronization messages with full contact and group lists.
706
707 === uploadStickerPack
708
709 Upload a new sticker pack, consisting of a manifest file and the sticker images. +
710 Images must conform to the following specification: (see https://support.signal.org/hc/en-us/articles/360031836512-Stickers#sticker_reqs )
711
712 - Static stickers in PNG or WebP format
713 - Animated stickers in APNG format,
714 - Maximum file size for a sticker file is 300KiB
715 - Image resolution of 512 x 512 px
716
717 The required manifest.json has the following format:
718
719 [source,json]
720 ----
721 {
722 "title": "<STICKER_PACK_TITLE>",
723 "author": "<STICKER_PACK_AUTHOR>",
724 "cover": { // Optional cover, by default the first sticker is used as cover
725 "file": "<name of image file, mandatory>",
726 "contentType": "<optional>",
727 "emoji": "<optional>"
728 },
729 "stickers": [
730 {
731 "file": "<name of image file, mandatory>",
732 "contentType": "<optional>",
733 "emoji": "<optional>"
734 }
735 ...
736 ]
737 }
738 ----
739
740 PATH::
741 The path of the manifest.json or a zip file containing the sticker pack you wish to upload.
742
743 === listStickerPacks
744
745 Show a list of known sticker packs.
746
747 === addStickerPack
748
749 Install a sticker pack for this account.
750
751 *--uri* [URI]::
752 Specify the uri of the sticker pack.
753 e.g. https://signal.art/addstickers/#pack_id=XXX&pack_key=XXX
754
755 === getAttachment
756
757 Gets the raw data for a specified attachment.
758 This is done using the ID of the attachment the recipient or group ID.
759 The attachment data is returned as a Base64 String.
760
761 *--id* [ID]::
762 The ID of the attachment as given in the attachment list of the message.
763
764 *--recipient* [RECIPIENT]::
765 Specify the number which sent the attachment.
766 Referred to generally as recipient.
767
768 *-g* [GROUP], *--group-id* [GROUP]::
769 Alternatively, specify the group IDs for which to get the attachment.
770
771 === getAvatar
772
773 Gets the raw data for a specified contact, contact's profile or group avatar.
774 The attachment data is returned as a Base64 String.
775
776 *--contact* [RECIPIENT]::
777 Specify the number of a recipient.
778
779 *--profile* [RECIPIENT]::
780 Specify the number of a recipient.
781
782 *-g* [GROUP], *--group-id* [GROUP]::
783 Alternatively, specify the group ID for which to get the avatar.
784
785 === getSticker
786
787 Gets the raw data for a specified sticker.
788 The attachment data is returned as a Base64 String.
789
790 *--pack-id* [PACK_ID]::
791 Specify the id of a sticker pack (hex encoded).
792
793 *--sticker-id* [STICKER_ID]::
794 Specify the index of a sticker in the sticker pack.
795
796 === daemon
797
798 signal-cli can run in daemon mode and provides JSON-RPC or an experimental dbus interface.
799 If no `-a` account is given, all local accounts will be loaded.
800 Multiple interfaces can be used at the same time, e.g. `daemon --socket --dbus`
801
802 *--socket [SOCKET]*::
803 Export a JSON-RPC interface on a UNIX socket (default $XDG_RUNTIME_DIR/signal-cli/socket). +
804 See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
805
806 *--tcp [HOST:PORT]*::
807 Export a JSON-RPC interface on a TCP socket (default localhost:7583). +
808 See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
809
810 *--http [HOST:PORT]*::
811 Expose a JSON-RPC interface as http endpoint (default localhost:8080).
812 The JSON-RPC endpoint is `/api/v1/rpc`. +
813 See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
814
815 *--dbus*::
816 Export DBus interface on user bus. +
817 See **signal-cli-dbus**(5) for info on the dbus interface.
818
819 *--dbus-system*::
820 Export DBus interface on system bus. +
821 See **signal-cli-dbus**(5) for info on the dbus interface.
822
823 *--bus-name*::
824 Claim another D-Bus bus name than the default.
825
826 *--ignore-attachments*::
827 Don’t download attachments of received messages.
828
829 *--ignore-stories*::
830 Don’t receive story messages from the server.
831
832 *--send-read-receipts*::
833 Send read receipts for all incoming data messages (in addition to the default delivery receipts)
834
835 *--no-receive-stdout*::
836 Don’t print received messages to stdout.
837
838 *--receive-mode*::
839 Specify when to start receiving messages (on-start, on-connection, manual)
840
841 === jsonRpc
842
843 Run in signal-cli in JSON-RPC mode.
844 Reads JSON-RPC requests on stdin and responds on stdout.
845 See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
846
847 *--ignore-attachments*::
848 Don’t download attachments of received messages.
849
850 *--ignore-stories*::
851 Don’t receive story messages from the server.
852
853 *--send-read-receipts*::
854 Send read receipts for all incoming data messages (in addition to the default delivery receipts)
855
856 *--receive-mode*::
857 Specify when to start receiving messages (on-start, manual)
858
859 === submitRateLimitChallenge
860
861 When running into rate limits, sometimes the limit can be lifted, by solving a CAPTCHA.
862 To get the captcha token, go to https://signalcaptchas.org/challenge/generate.html
863 For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html
864
865 *--challenge* CHALLENGE_TOKEN::
866 The challenge token from the failed send attempt.
867
868 *--captcha* CAPTCHA::
869 The captcha result, starting with signalcaptcha://
870
871 == Examples
872
873 Register a number (with SMS verification)::
874 signal-cli -a ACCOUNT register
875
876 Verify the number using the code received via SMS or voice::
877 signal-cli -a ACCOUNT verify CODE
878
879 Send a message to one or more recipients::
880 signal-cli -a ACCOUNT send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
881
882 Pipe the message content from another process::
883 uname -a | signal-cli -a ACCOUNT send --message-from-stdin [RECIPIENT [RECIPIENT ...]]
884
885 Create a group::
886 signal-cli -a ACCOUNT updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
887
888 Add member to a group::
889 signal-cli -a ACCOUNT updateGroup -g GROUP_ID -m "NEW_MEMBER"
890
891 Accept a group invitation::
892 signal-cli -a ACCOUNT updateGroup -g GROUP_ID
893
894 Leave a group::
895 signal-cli -a ACCOUNT quitGroup -g GROUP_ID
896
897 Send a message to a group::
898 signal-cli -a ACCOUNT send -m "This is a message" -g GROUP_ID
899
900 Trust new key, after having verified it::
901 signal-cli -a ACCOUNT trust -v SAFETY_NUMBER NUMBER
902
903 Trust new key, without having verified it. Only use this if you don't care about security::
904 signal-cli -a ACCOUNT trust -a NUMBER
905
906 == Exit codes
907
908 * *1*: Error is probably caused and fixable by the user
909 * *2*: Some unexpected error
910 * *3*: Server or IO error
911 * *4*: Sending failed due to untrusted key
912 * *5*: Server rate limiting error
913
914 == Files
915
916 The password and cryptographic keys are created when registering and stored in the current users home directory, the directory can be changed with *--config*:
917
918 `$XDG_DATA_HOME/signal-cli/` (`$HOME/.local/share/signal-cli/`)
919
920 == Authors
921
922 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
923 For more information about signal-cli development, see
924 <https://github.com/AsamK/signal-cli>.