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