mirror of
https://github.com/AsamK/signal-cli
synced 2025-08-29 02:20:39 +00:00
Update documentation
This commit is contained in:
parent
bb78e9aaeb
commit
24069c8277
3 changed files with 39 additions and 3 deletions
|
@ -32,8 +32,8 @@ See [latest version](https://github.com/AsamK/signal-cli/releases).
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
export VERSION=<latest version, format "x.y.z">
|
export VERSION=<latest version, format "x.y.z">
|
||||||
wget https://github.com/AsamK/signal-cli/releases/download/v"${VERSION}"/signal-cli-"${VERSION}"-Linux.tar.gz
|
wget https://github.com/AsamK/signal-cli/releases/download/v"${VERSION}"/signal-cli-"${VERSION}".tar.gz
|
||||||
sudo tar xf signal-cli-"${VERSION}"-Linux.tar.gz -C /opt
|
sudo tar xf signal-cli-"${VERSION}".tar.gz -C /opt
|
||||||
sudo ln -sf /opt/signal-cli-"${VERSION}"/bin/signal-cli /usr/local/bin/
|
sudo ln -sf /opt/signal-cli-"${VERSION}"/bin/signal-cli /usr/local/bin/
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -96,6 +96,7 @@ If the account was deleted (with --delete-account) it cannot be reactivated.
|
||||||
|
|
||||||
*-v*, *--voice*::
|
*-v*, *--voice*::
|
||||||
The verification should be done over voice, not SMS.
|
The verification should be done over voice, not SMS.
|
||||||
|
Voice verification only works if an SMS verification has been attempted before.
|
||||||
|
|
||||||
*--captcha*::
|
*--captcha*::
|
||||||
The captcha token, required if registration failed with a captcha required error.
|
The captcha token, required if registration failed with a captcha required error.
|
||||||
|
@ -146,6 +147,38 @@ Can fix problems with receiving messages.
|
||||||
*-n* NAME, *--device-name* NAME::
|
*-n* NAME, *--device-name* NAME::
|
||||||
Set a new device name for the primary or linked device
|
Set a new device name for the primary or linked device
|
||||||
|
|
||||||
|
=== startChangeNumber
|
||||||
|
|
||||||
|
Change an account to a new phone number with SMS or voice verification.
|
||||||
|
Use the finishChangeNumber command to complete the verification.
|
||||||
|
|
||||||
|
NUMBER::
|
||||||
|
The new phone number.
|
||||||
|
|
||||||
|
*-v*, *--voice*::
|
||||||
|
The verification should be done over voice, not SMS.
|
||||||
|
Voice verification only works if an SMS verification has been attempted before.
|
||||||
|
|
||||||
|
*--captcha*::
|
||||||
|
The captcha token, required if registration failed with a captcha required error.
|
||||||
|
To get the token, go to https://signalcaptchas.org/registration/generate.html
|
||||||
|
For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html
|
||||||
|
Check the developer tools for a redirect starting with signalcaptcha:// Everything after signalcaptcha:// is the captcha token.
|
||||||
|
|
||||||
|
=== finishChangeNumber
|
||||||
|
|
||||||
|
Verify the number using the code received via SMS or voice.
|
||||||
|
|
||||||
|
NUMBER::
|
||||||
|
The new phone number.
|
||||||
|
|
||||||
|
*-v*, *--verification-code*::
|
||||||
|
The verification code.
|
||||||
|
|
||||||
|
*-p* PIN, *--pin* PIN::
|
||||||
|
The registration lock PIN, that was set by the user.
|
||||||
|
Only required if a PIN was set.
|
||||||
|
|
||||||
=== updateConfiguration
|
=== updateConfiguration
|
||||||
|
|
||||||
Update signal configs and sync them to linked devices.
|
Update signal configs and sync them to linked devices.
|
||||||
|
@ -272,6 +305,9 @@ Specify the mentions of the original message (same format as `--mention`).
|
||||||
*--quote-text-style*::
|
*--quote-text-style*::
|
||||||
Style parts of the original message text (same format as `--text-style`).
|
Style parts of the original message text (same format as `--text-style`).
|
||||||
|
|
||||||
|
*--quote-attachment*::
|
||||||
|
Specify the attachments of the original message (syntax: contentType[:filename[:previewFile]]), e.g. 'audio/aac' or 'image/png:test.png:/tmp/preview.jpg'.
|
||||||
|
|
||||||
*--preview-url*::
|
*--preview-url*::
|
||||||
Specify the url for the link preview.
|
Specify the url for the link preview.
|
||||||
The same url must also appear in the message body, otherwise the preview won't be displayed by the apps.
|
The same url must also appear in the message body, otherwise the preview won't be displayed by the apps.
|
||||||
|
|
|
@ -80,7 +80,7 @@ public class SendCommand implements JsonRpcLocalCommand {
|
||||||
.help("Quote with mention of another group member (syntax: start:length:recipientNumber)");
|
.help("Quote with mention of another group member (syntax: start:length:recipientNumber)");
|
||||||
subparser.addArgument("--quote-attachment")
|
subparser.addArgument("--quote-attachment")
|
||||||
.nargs("*")
|
.nargs("*")
|
||||||
.help("Specify the attachments of the original message (syntax: contentType[:filename[:previewFile]], e.g. 'audio/aac' or 'image/png:test.png:/tmp/preview.jpg'.");
|
.help("Specify the attachments of the original message (syntax: contentType[:filename[:previewFile]]), e.g. 'audio/aac' or 'image/png:test.png:/tmp/preview.jpg'.");
|
||||||
subparser.addArgument("--quote-text-style")
|
subparser.addArgument("--quote-text-style")
|
||||||
.nargs("*")
|
.nargs("*")
|
||||||
.help("Quote with style parts of the message text (syntax: start:length:STYLE)");
|
.help("Quote with style parts of the message text (syntax: start:length:STYLE)");
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue