X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/4f50668fe360cc4d42d02ae36783952a9334a9d2..0476895c3d9e843e505ef768340d7969b084cada:/man/signal-cli.1.adoc diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc index 57016413..02ae4ca4 100644 --- a/man/signal-cli.1.adoc +++ b/man/signal-cli.1.adoc @@ -8,7 +8,7 @@ vim:set ts=4 sw=4 tw=82 noet: == Name -signal-cli - A commandline and dbus interface for the Signal messenger +signal-cli - A commandline interface for the Signal messenger == Synopsis @@ -20,7 +20,7 @@ signal-cli is a commandline interface for libsignal-service-java. It supports registering, verifying, sending and receiving messages. For registering you need a phone number where you can receive SMS or incoming calls. signal-cli was primarily developed to be used on servers to notify admins of important events. -For this use-case, it has a dbus interface, that can be used to send messages from any programming language that has dbus bindings. +For this use-case, it has a dbus and a JSON-RPC interface, that can be used to send messages from other programs. For some functionality the Signal protocol requires that all messages have been received from the server. The `receive` command should be regularly executed. @@ -37,6 +37,10 @@ Print the version and quit. *--verbose*:: Raise log level and include lib signal logs. +*--log-file* LOG_FILE:: +Write log output to the given file. +If `--verbose` is also given, the detailed logs will only be written to the log file. + *--config* CONFIG:: Set the path, where to store the config. Make sure you have full read/write access to the given directory. @@ -50,6 +54,12 @@ This flag must not be given for the `link` command. It is optional for the `daemon` command. For all other commands it is only optional if there is exactly one local user in the config directory. +*--service-environment* ENVIRONMENT:: +Choose the server environment to use: + +- `live` (default) +- `staging` + *--dbus*:: Make request via user dbus. @@ -73,11 +83,9 @@ Choose when to trust new identities: Register a phone number with SMS or voice verification. Use the verify command to complete the verification. -If the account is just deactivated, the register command will just reactivate -account, without requiring an SMS verification. 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. If the account was deleted -(with --delete-account) it cannot be reactivated. +If the account is just deactivated, the register command will just reactivate account, without requiring an SMS verification. +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. +If the account was deleted (with --delete-account) it cannot be reactivated. *-v*, *--voice*:: The verification should be done over voice, not SMS. @@ -197,6 +205,9 @@ Send a message to another user or group. RECIPIENT:: Specify the recipients’ phone number. +*--note-to-self*:: +Send the message to self without notification. + *-g* GROUP, *--group-id* GROUP:: Specify the recipient group ID in base64 encoding. @@ -206,11 +217,10 @@ Specify the message, if missing, standard input is used. *-a* [ATTACHMENT [ATTACHMENT ...]], *--attachment* [ATTACHMENT [ATTACHMENT ...]]:: Add one or more files as attachment. -*--note-to-self*:: -Send the message to self without notification. - -*-e*, *--end-session*:: -Clear session state and send end session message. +*--sticker* STICKER:: +Send a sticker of a locally known sticker pack (syntax: stickerPackId:stickerId). +Shouldn't be used together with `-m` as the official clients don't support this. +e.g.: `--sticker 00abac3bc18d7f599bff2325dc306d43:2` *--mention*:: 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. @@ -228,6 +238,9 @@ Specify the message of the original message. *--quote-mention*:: Specify the mentions of the original message (same format as `--mention`). +*-e*, *--end-session*:: +Clear session state and send end session message. + === sendReaction Send reaction to a previously received or sent message.