]> nmode's Git Repositories - signal-cli/blob - man/signal-cli.1.adoc
90b2c97d99cf3fa882ff7ea800f01f81cefd4d6a
[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
9 == Name
10
11 signal-cli - A commandline interface for the Signal messenger
12
13 == Synopsis
14
15 *signal-cli* [--config CONFIG] [-h | -v | -a ACCOUNT | --dbus | --dbus-system] command [command-options]
16
17 == Description
18
19 signal-cli is a commandline interface for libsignal-service-java.
20 It supports registering, verifying, sending and receiving messages.
21 For registering you need a phone number where you can receive SMS or incoming calls.
22 signal-cli was primarily developed to be used on servers to notify admins of important events.
23 For this use-case, it has a dbus and a JSON-RPC interface, that can be used to send messages from other programs.
24
25 For some functionality the Signal protocol requires that all messages have been received from the server.
26 The `receive` command should be regularly executed.
27 In daemon mode messages are continuously received.
28
29 == Options
30
31 *-h*, *--help*::
32 Show help message and quit.
33
34 *--version*::
35 Print the version and quit.
36
37 *-v*, *--verbose*::
38 Raise log level and include lib signal logs.
39
40 *--log-file* LOG_FILE::
41 Write log output to the given file.
42 If `--verbose` is also given, the detailed logs will only be written to the log file.
43
44 *--scrub-log*::
45 Scrub possibly sensitive information from the log, like phone numbers and UUIDs.
46
47 *--config* CONFIG::
48 Set the path, where to store the config.
49 Make sure you have full read/write access to the given directory.
50 (Default: `$XDG_DATA_HOME/signal-cli` (`$HOME/.local/share/signal-cli`))
51
52 *-a* ACCOUNT, *--account* ACCOUNT::
53 Specify your phone number, that will be your identifier.
54 The phone number must include the country calling code, i.e. the number must start with a "+" sign.
55
56 This flag must not be given for the `link` command.
57 It is optional for the `daemon` command.
58 For all other commands it is only optional if there is exactly one local user in the config directory.
59
60 *--service-environment* ENVIRONMENT::
61 Choose the server environment to use:
62
63 - `live` (default)
64 - `staging`
65
66 *--dbus*::
67 Make request via user dbus.
68
69 *--dbus-system*::
70 Make request via system dbus.
71
72 *-o* OUTPUT-MODE, *--output* OUTPUT-MODE::
73 Specify if you want commands to output in either "plain-text" mode or in "json".
74 Defaults to "plain-text"
75
76 *--trust-new-identities* TRUST-MODE::
77 Choose when to trust new identities:
78 - `on-first-use` (default): Trust the first seen identity key from new users, changed keys must be verified manually
79 - `always`: Trust any new identity key without verification
80 - `never`: Don't trust any unknown identity key, every key must be verified manually
81
82 *--disable-send-log*::
83 Disable message send log (for resending messages that recipient couldn't decrypt).
84
85 == Commands
86
87 === register
88
89 Register a phone number with SMS or voice verification.
90 Use the verify command to complete the verification.
91
92 If the account is just deactivated, the register command will just reactivate account, without requiring an SMS verification.
93 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.
94 If the account was deleted (with --delete-account) it cannot be reactivated.
95
96 *-v*, *--voice*::
97 The verification should be done over voice, not SMS.
98
99 *--captcha*::
100 The captcha token, required if registration failed with a captcha required error.
101 To get the token, go to https://signalcaptchas.org/registration/generate.html
102 For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html
103 Check the developer tools for a redirect starting with signalcaptcha:// Everything after signalcaptcha:// is the captcha token.
104
105 === verify
106
107 Verify the number using the code received via SMS or voice.
108
109 VERIFICATIONCODE::
110 The verification code.
111
112 *-p* PIN, *--pin* PIN::
113 The registration lock PIN, that was set by the user.
114 Only required if a PIN was set.
115
116 === unregister
117
118 Disable push support for this device, i.e. this device won't receive any more messages.
119 If this is the primary device, other users can't send messages to this number anymore.
120 Use "updateAccount" to undo this.
121 To remove a linked device, use "removeDevice" from the primary device.
122
123 *--delete-account*::
124 Delete account completely from server.
125 Cannot be undone without loss.
126 You will have to be readded to each group.
127
128 CAUTION: Only delete your account if you won't use this number again!
129
130 === deleteLocalAccountData
131
132 Delete all local data for this account.
133 Data should only be deleted if the account is unregistered.
134
135 CAUTION: This cannot be undone.
136
137 *--ignore-registered*::
138 Delete the account data even though the account is still registered on the Signal servers.
139
140 === updateAccount
141
142 Update the account attributes on the signal server.
143 Can fix problems with receiving messages.
144
145 *-n* NAME, *--device-name* NAME::
146 Set a new device name for the primary or linked device
147
148 === updateConfiguration
149
150 Update signal configs and sync them to linked devices.
151 This command only works on the primary devices.
152
153 *--read-receipts* {true,false}::
154 Indicates if Signal should send read receipts.
155
156 *--unidentified-delivery-indicators* {true,false}::
157 Indicates if Signal should show unidentified delivery indicators.
158
159 *--typing-indicators* {true,false}::
160 Indicates if Signal should send/show typing indicators.
161
162 *--link-previews* {true,false}::
163 Indicates if Signal should generate link previews.
164
165 === setPin
166
167 Set a registration lock pin, to prevent others from registering this number.
168
169 REGISTRATION_LOCK_PIN::
170 The registration lock PIN, that will be required for new registrations (resets after 7 days of inactivity)
171
172 === removePin
173
174 Remove the registration lock pin.
175
176 === link
177
178 Link to an existing device, instead of registering a new number.
179 This shows a "sgnl://linkdevice?uuid=..." URI.
180 If you want to connect to another signal-cli instance, you can just use this URI.
181 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.
182
183 *-n* NAME, *--name* NAME::
184 Optionally specify a name to describe this new device.
185 By default "cli" will be used.
186
187 === addDevice
188
189 Link another device to this device.
190 Only works, if this is the primary device.
191
192 *--uri* URI::
193 Specify the uri contained in the QR code shown by the new device.
194 You will need the full URI such as "sgnl://linkdevice?uuid=..." (formerly "tsdevice:/?uuid=...") Make sure to enclose it in quotation marks for shells.
195
196 === listDevices
197
198 Show a list of linked devices.
199
200 === removeDevice
201
202 Remove a linked device.
203 Only works, if this is the primary device.
204
205 *-d* DEVICE_ID, *--device-id* DEVICE_ID::
206 Specify the device you want to remove.
207 Use listDevices to see the deviceIds.
208
209 === getUserStatus
210
211 Uses a list of phone numbers to determine the statuses of those users.
212 Shows if they are registered on the Signal Servers or not.
213 In json mode this is outputted as a list of objects.
214
215 [NUMBER [NUMBER ...]]::
216 One or more numbers to check.
217
218 === send
219
220 Send a message to another user or group.
221
222 RECIPIENT::
223 Specify the recipients’ phone number.
224
225 *--note-to-self*::
226 Send the message to self without notification.
227
228 *-g* GROUP, *--group-id* GROUP::
229 Specify the recipient group ID in base64 encoding.
230
231 *-m* MESSAGE, *--message* MESSAGE::
232 Specify the message.
233
234 *--message-from-stdin*::
235 Read the message from standard input.
236
237 *-a* [ATTACHMENT [ATTACHMENT ...]], *--attachment* [ATTACHMENT [ATTACHMENT ...]]::
238 Add one or more files as attachment.
239 Can be either a file path or a data URI.
240 Data URI encoded attachments must follow the RFC 2397.
241 Additionally a file name can be added:
242 e.g.: `data:<MIME-TYPE>;filename=<FILENAME>;base64,<BASE64 ENCODED DATA>`
243
244 *--sticker* STICKER::
245 Send a sticker of a locally known sticker pack (syntax: stickerPackId:stickerId).
246 Shouldn't be used together with `-m` as the official clients don't support this.
247 e.g.: `--sticker 00abac3bc18d7f599bff2325dc306d43:2`
248
249 *--mention*::
250 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.
251 e.g.: `-m "Hi X!" --mention "3:1:+123456789"`
252
253 *--quote-timestamp*::
254 Specify the timestamp of a previous message with the recipient or group to add a quote to the new message.
255
256 *--quote-author*::
257 Specify the number of the author of the original message.
258
259 *--quote-message*::
260 Specify the message of the original message.
261
262 *--quote-mention*::
263 Specify the mentions of the original message (same format as `--mention`).
264
265 *--preview-url*::
266 Specify the url for the link preview.
267 The same url must also appear in the message body, otherwise the preview won't be displayed by the apps.
268
269 *--preview-title*::
270 Specify the title for the link preview (mandatory).
271
272 *--preview-description*::
273 Specify the description for the link preview (optional).
274
275 *--preview-image*::
276 Specify the image file for the link preview (optional).
277
278 *-e*, *--end-session*::
279 Clear session state and send end session message.
280
281 === sendPaymentNotification
282
283 Send a payment notification.
284
285 RECIPIENT::
286 Specify the recipient’s phone number.
287
288 *--receipt* RECEIPT::
289 The base64 encoded receipt blob.
290
291 *--note* NOTE::
292 Specify a note for the payment notification.
293
294 === sendReaction
295
296 Send reaction to a previously received or sent message.
297
298 RECIPIENT::
299 Specify the recipients’ phone number.
300
301 *-g* GROUP, *--group-id* GROUP::
302 Specify the recipient group ID in base64 encoding.
303
304 *-e* EMOJI, *--emoji* EMOJI::
305 Specify the emoji, should be a single unicode grapheme cluster.
306
307 *-a* NUMBER, *--target-author* NUMBER::
308 Specify the number of the author of the message to which to react.
309
310 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
311 Specify the timestamp of the message to which to react.
312
313 *-r*, *--remove*::
314 Remove a reaction.
315
316 === sendReceipt
317
318 Send a read or viewed receipt to a previously received message.
319
320 RECIPIENT::
321 Specify the sender’s phone number.
322
323 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
324 Specify the timestamp of the message to which to react.
325
326 *--type* TYPE::
327 Specify the receipt type, either `read` (the default) or `viewed`.
328
329 === sendTyping
330
331 Send typing message to trigger a typing indicator for the recipient.
332 Indicator will be shown for 15seconds unless a typing STOP message is sent first.
333
334 RECIPIENT::
335 Specify the recipients’ phone number.
336
337 *-g* GROUP, *--group-id* GROUP::
338 Specify the recipient group ID in base64 encoding.
339
340 *-s*, *--stop*::
341 Send a typing STOP message.
342
343 === remoteDelete
344
345 Remotely delete a previously sent message.
346
347 RECIPIENT::
348 Specify the recipients’ phone number.
349
350 *-g* GROUP, *--group-id* GROUP::
351 Specify the recipient group ID in base64 encoding.
352
353 *-t* TIMESTAMP, *--target-timestamp* TIMESTAMP::
354 Specify the timestamp of the message to delete.
355
356 === receive
357
358 Query the server for new messages.
359 New messages are printed on standard output and attachments are downloaded to the config directory.
360 In json mode this is outputted as one json object per line.
361
362 *-t* TIMEOUT, *--timeout* TIMEOUT::
363 Number of seconds to wait for new messages (negative values disable timeout).
364 Default is 5 seconds.
365
366 *--ignore-attachments*::
367 Don’t download attachments of received messages.
368
369 *--ignore-stories*::
370 Don’t receive story messages from the server.
371
372
373 *--send-read-receipts*::
374 Send read receipts for all incoming data messages (in addition to the default delivery receipts)
375
376 === joinGroup
377
378 Join a group via an invitation link.
379
380 *--uri*::
381 The invitation link URI (starts with `https://signal.group/#`)
382
383 === updateGroup
384
385 Create or update a group.
386 If the user is a pending member, this command will accept the group invitation.
387
388 *-g* GROUP, *--group-id* GROUP::
389 Specify the recipient group ID in base64 encoding.
390 If not specified, a new group with a new random ID is generated.
391
392 *-n* NAME, *--name* NAME::
393 Specify the new group name.
394
395 *-d* DESCRIPTION, *--description* DESCRIPTION::
396 Specify the new group description.
397
398 *-a* AVATAR, *--avatar* AVATAR::
399 Specify a new group avatar image file.
400
401 *-m* [MEMBER [MEMBER ...]], *--member* [MEMBER [MEMBER ...]]::
402 Specify one or more members to add to the group.
403
404 *-r* [MEMBER [MEMBER ...]], *--remove-member* [MEMBER [MEMBER ...]]::
405 Specify one or more members to remove from the group
406
407 *--admin* [MEMBER [MEMBER ...]]::
408 Specify one or more members to make a group admin
409
410 *--remove-admin* [MEMBER [MEMBER ...]]::
411 Specify one or more members to remove group admin privileges
412
413 *--ban* [MEMBER [MEMBER ...]]::
414 Specify one or more members to ban from joining the group.
415 Banned members cannot join or request to join via a group link.
416
417 *--unban* [MEMBER [MEMBER ...]]::
418 Specify one or more members to remove from the ban list
419
420 *--reset-link*::
421 Reset group link and create new link password
422
423 *--link* LINK_STATE::
424 Set group link state: `enabled`, `enabled-with-approval`, `disabled`
425
426 *--set-permission-add-member* PERMISSION::
427 Set permission to add new group members: `every-member`, `only-admins`
428
429 *--set-permission-edit-details* PERMISSION::
430 Set permission to edit group details: `every-member`, `only-admins`
431
432 *--set-permission-send-messages* PERMISSION::
433 Set permission to send messages in group: `every-member`, `only-admins`
434 Groups where only admins can send messages are also called announcement groups
435
436 *-e* EXPIRATION_SECONDS, *--expiration* EXPIRATION_SECONDS::
437 Set expiration time of messages (seconds).
438 To disable expiration set expiration time to 0.
439
440 === quitGroup
441
442 Send a quit group message to all group members and remove self from member list.
443 If the user is a pending member, this command will decline the group invitation.
444
445 *-g* GROUP, *--group-id* GROUP::
446 Specify the recipient group ID in base64 encoding.
447
448 *--delete*::
449 Delete local group data completely after quitting group.
450
451 === listGroups
452
453 Show a list of known groups and related information.
454 In json mode this is outputted as an list of objects and is always in detailed mode.
455
456 *-d*, *--detailed*::
457 Include the list of members of each group and the group invite link.
458
459 *-g*, *--group-id*::
460 Filter the group list by one or more group IDs.
461
462 === listContacts
463
464 Show a list of known contacts with names and profiles.
465 When a specific recipient is given, its profile will be refreshed.
466
467 RECIPIENT::
468 Specify the recipients’ phone number.
469
470 *-a*, *--all-recipients*::
471 Include all known recipients, not only contacts.
472
473 *--blocked*::
474 Specify if only blocked or unblocked contacts should be shown (default: all contacts)
475
476 *--name*::
477 Find contacts with the given contact or profile name.
478
479 === listIdentities
480
481 List all known identity keys and their trust status, fingerprint and safety number.
482
483 *-n* NUMBER, *--number* NUMBER::
484 Only show identity keys for the given phone number.
485
486 === trust
487
488 Set the trust level of a given number.
489 The first time a key for a number is seen, it is trusted by default (TOFU).
490 If the key changes, the new key must be trusted manually.
491
492 number::
493 Specify the phone number, for which to set the trust.
494
495 *-a*, *--trust-all-known-keys*::
496 Trust all known keys of this user, only use this for testing.
497
498 *-v* VERIFIED_SAFETY_NUMBER, *--verified-safety-number* VERIFIED_SAFETY_NUMBER::
499 Specify the safety number of the key, only use this option if you have verified the safety number.
500 Can be either the plain text numbers shown in the app or the bytes from the QR-code, encoded as base64.
501
502 === updateProfile
503
504 Update the profile information shown to message recipients.
505 The profile is stored encrypted on the Signal servers.
506 The decryption key is sent with every outgoing messages to contacts and included in every group.
507
508 *--given-name* NAME, *--name* NAME::
509 New (given) name.
510
511 *--family-name* FAMILY_NAME::
512 New family name.
513
514 *--about* ABOUT_TEXT::
515 New profile status text.
516
517 *--about-emoji* EMOJI::
518 New profile status emoji.
519
520 *--avatar* AVATAR_FILE::
521 Path to the new avatar image file.
522
523 *--remove-avatar*::
524 Remove the avatar
525
526 *--mobile-coin-address*::
527 New MobileCoin address (Base64 encoded public address)
528
529 === updateContact
530
531 Update the info associated to a number on our contact list.
532 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
533 If the contact doesn't exist yet, it will be added.
534
535 NUMBER::
536 Specify the contact phone number.
537
538 *--given-name* NAME, *--name* NAME::
539 New (given) name.
540
541 *--family-name* FAMILY_NAME::
542 New family name.
543
544 *-e*, *--expiration* EXPIRATION_SECONDS::
545 Set expiration time of messages (seconds).
546 To disable expiration set expiration time to 0.
547
548 === removeContact
549
550 Remove the info of a given contact
551
552 NUMBER::
553 Specify the contact phone number.
554
555 *--forget*::
556 Delete all data associated with this contact, including identity keys and sessions.
557
558 === block
559
560 Block the given contacts or groups (no messages will be received).
561 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
562
563 [CONTACT [CONTACT ...]]::
564 Specify the phone numbers of contacts that should be blocked.
565
566 *-g* [GROUP [GROUP ...]], *--group-id* [GROUP [GROUP ...]]::
567 Specify the group IDs that should be blocked in base64 encoding.
568
569 === unblock
570
571 Unblock the given contacts or groups (messages will be received again).
572 This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
573
574 [CONTACT [CONTACT ...]]::
575 Specify the phone numbers of contacts that should be unblocked.
576
577 *-g* [GROUP [GROUP ...]], *--group-id* [GROUP [GROUP ...]]::
578 Specify the group IDs that should be unblocked in base64 encoding.
579
580 === sendContacts
581
582 Send a synchronization message with the local contacts list to all linked devices.
583 This command should only be used if this is the primary device.
584
585 === sendSyncRequest
586
587 Send a synchronization request message to the primary device (for group, contacts, ...).
588 The primary device will respond with synchronization messages with full contact and group lists.
589
590 === uploadStickerPack
591
592 Upload a new sticker pack, consisting of a manifest file and the sticker images.
593 Images must conform to the following specification: (see https://support.signal.org/hc/en-us/articles/360031836512-Stickers#sticker_reqs )
594
595 - Static stickers in PNG or WebP format
596 - Animated stickers in APNG format,
597 - Maximum file size for a sticker file is 300KiB
598 - Image resolution of 512 x 512 px
599
600 The required manifest.json has the following format:
601
602 [source,json]
603 ----
604 {
605 "title": "<STICKER_PACK_TITLE>",
606 "author": "<STICKER_PACK_AUTHOR>",
607 "cover": { // Optional cover, by default the first sticker is used as cover
608 "file": "<name of image file, mandatory>",
609 "contentType": "<optional>",
610 "emoji": "<optional>"
611 },
612 "stickers": [
613 {
614 "file": "<name of image file, mandatory>",
615 "contentType": "<optional>",
616 "emoji": "<optional>"
617 }
618 ...
619 ]
620 }
621 ----
622
623 PATH::
624 The path of the manifest.json or a zip file containing the sticker pack you wish to upload.
625
626 === daemon
627
628 signal-cli can run in daemon mode and provides an experimental dbus or JSON-RPC interface.
629 If no `-a` account is given, all local accounts will be exported as separate dbus objects under the same bus name.
630
631 *--dbus*::
632 Export DBus interface on user bus.
633 See signal-cli-dbus (5) for info on the dbus interface.
634
635 *--dbus-system*::
636 Export DBus interface on system bus.
637 See signal-cli-dbus (5) for info on the dbus interface.
638
639 *--socket [SOCKET]*::
640 Export a JSON-RPC interface on a UNIX socket (default $XDG_RUNTIME_DIR/signal-cli/socket).
641 See signal-cli-jsonrpc (5) for info on the JSON-RPC interface.
642
643 *--tcp [HOST:PORT]*::
644 Export a JSON-RPC interface on a TCP socket (default localhost:7583).
645 See signal-cli-jsonrpc (5) for info on the JSON-RPC interface.
646
647 *--ignore-attachments*::
648 Don’t download attachments of received messages.
649
650 *--ignore-stories*::
651 Don’t receive story messages from the server.
652
653 *--send-read-receipts*::
654 Send read receipts for all incoming data messages (in addition to the default delivery receipts)
655
656 *--no-receive-stdout*::
657 Don’t print received messages to stdout.
658
659 *--receive-mode*::
660 Specify when to start receiving messages (on-start, on-connection, manual)
661
662 == Examples
663
664 Register a number (with SMS verification)::
665 signal-cli -a ACCOUNT register
666
667 Verify the number using the code received via SMS or voice::
668 signal-cli -a ACCOUNT verify CODE
669
670 Send a message to one or more recipients::
671 signal-cli -a ACCOUNT send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
672
673 Pipe the message content from another process::
674 uname -a | signal-cli -a ACCOUNT send --message-from-stdin [RECIPIENT [RECIPIENT ...]]
675
676 Create a group::
677 signal-cli -a ACCOUNT updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
678
679 Add member to a group::
680 signal-cli -a ACCOUNT updateGroup -g GROUP_ID -m "NEW_MEMBER"
681
682 Accept a group invitation::
683 signal-cli -a ACCOUNT updateGroup -g GROUP_ID
684
685 Leave a group::
686 signal-cli -a ACCOUNT quitGroup -g GROUP_ID
687
688 Send a message to a group::
689 signal-cli -a ACCOUNT send -m "This is a message" -g GROUP_ID
690
691 Trust new key, after having verified it::
692 signal-cli -a ACCOUNT trust -v SAFETY_NUMBER NUMBER
693
694 Trust new key, without having verified it. Only use this if you don't care about security::
695 signal-cli -a ACCOUNT trust -a NUMBER
696
697 == Exit codes
698
699 * *1*: Error is probably caused and fixable by the user
700 * *2*: Some unexpected error
701 * *3*: Server or IO error
702 * *4*: Sending failed due to untrusted key
703
704 == Files
705
706 The password and cryptographic keys are created when registering and stored in the current users home directory, the directory can be changed with *--config*:
707
708 `$XDG_DATA_HOME/signal-cli/` (`$HOME/.local/share/signal-cli/`)
709
710 == Authors
711
712 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
713 For more information about signal-cli development, see
714 <https://github.com/AsamK/signal-cli>.