+*--forget*::
+Delete all data associated with this contact, including identity keys and sessions.
+
+=== block
+
+Block the given contacts or groups (no messages will be received).
+This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
+
+[CONTACT [CONTACT ...]]::
+Specify the phone numbers of contacts that should be blocked.
+
+*-g* [GROUP [GROUP ...]], *--group-id* [GROUP [GROUP ...]]::
+Specify the group IDs that should be blocked in base64 encoding.
+
+=== unblock
+
+Unblock the given contacts or groups (messages will be received again).
+This change is only local but can be synchronized to other devices by using `sendContacts` (see below).
+
+[CONTACT [CONTACT ...]]::
+Specify the phone numbers of contacts that should be unblocked.
+
+*-g* [GROUP [GROUP ...]], *--group-id* [GROUP [GROUP ...]]::
+Specify the group IDs that should be unblocked in base64 encoding.
+
+=== sendContacts
+
+Send a synchronization message with the local contacts list to all linked devices.
+This command should only be used if this is the primary device.
+
+=== sendSyncRequest
+
+Send a synchronization request message to the primary device (for group, contacts, ...).
+The primary 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 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]
+----
+{
+ "title": "<STICKER_PACK_TITLE>",
+ "author": "<STICKER_PACK_AUTHOR>",
+ "cover": { // Optional cover, by default the first sticker is used as cover
+ "file": "<name of image file, mandatory>",
+ "contentType": "<optional>",
+ "emoji": "<optional>"
+ },
+ "stickers": [
+ {
+ "file": "<name of image file, mandatory>",
+ "contentType": "<optional>",
+ "emoji": "<optional>"
+ }
+ ...
+ ]
+}
+----
+
+PATH::
+The path of the manifest.json or a zip file containing the sticker pack you wish to upload.
+
+=== listStickerPacks
+
+Show a list of known sticker packs.
+
+=== addStickerPack
+
+Install a sticker pack for this account.
+
+*--uri* [URI]::
+Specify the uri of the sticker pack.
+e.g. https://signal.art/addstickers/#pack_id=XXX&pack_key=XXX)"
+
+=== getAttachment
+
+Gets the raw data for a specified attachment.
+This is done using the ID of the attachment the recipient or group ID.
+The attachment data is returned as a Base64 String.
+
+*--id* [ID]::
+The ID of the attachment as given in the attachment list of the message.
+
+*--recipient* [RECIPIENT]::
+Specify the number which sent the attachment.
+Referred to generally as recipient.
+
+*-g* [GROUP], *--group-id* [GROUP]::
+Alternatively, specify the group IDs for which to get the attachment.
+
+=== daemon
+
+signal-cli can run in daemon mode and provides an experimental dbus or JSON-RPC interface.
+If no `-a` account is given, all local accounts will be exported as separate dbus objects under the same bus name.
+
+*--dbus*::
+Export DBus interface on user bus. +
+See **signal-cli-dbus**(5) for info on the dbus interface.
+
+*--dbus-system*::
+Export DBus interface on system bus. +
+See **signal-cli-dbus**(5) for info on the dbus interface.
+
+*--socket [SOCKET]*::
+Export a JSON-RPC interface on a UNIX socket (default $XDG_RUNTIME_DIR/signal-cli/socket). +
+See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
+
+*--tcp [HOST:PORT]*::
+Export a JSON-RPC interface on a TCP socket (default localhost:7583). +
+See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
+
+*--http [HOST:PORT]*::
+Expose a JSON-RPC interface as http endpoint (default localhost:8080).
+The JSON-RPC endpoint is `/api/v1/rpc`. +
+See **signal-cli-jsonrpc**(5) for info on the JSON-RPC interface.
git.nmode.ca / signal-cli / blobdiff
