Update README
This commit is contained in:
parent
46f794cf42
commit
5c29236bc6
1 changed files with 10 additions and 22 deletions
|
@ -1,36 +1,24 @@
|
||||||
# signaldctl
|
# signaldctl
|
||||||
*a command line tool for [signald](https://gitlab.com/signald/signald)*
|
*a command line tool for [signald](https://gitlab.com/signald/signald)*
|
||||||
|
|
||||||
signaldctl is new and not well supported at this time. If you experience bugs, please report them.
|
# Install
|
||||||
|
|
||||||
|
If you have the [signald debian repo](https://gitlab.com/signald/signald/-/blob/main/docs/install/debian.md) installed:
|
||||||
|
|
||||||
## Account Creation: Linking
|
|
||||||
|
|
||||||
To link signald to an existing Signal account (by scanning a QR code):
|
|
||||||
|
|
||||||
```
|
```
|
||||||
signaldctl account create --link
|
sudo apt install signaldctl
|
||||||
```
|
```
|
||||||
|
|
||||||
## Account Creation: Registration
|
otherwise, download a binary from the CI:
|
||||||
|
* [x86_64](https://gitlab.com/api/v4/projects/21018340/jobs/artifacts/main/raw/signaldctl?job=build%3Ax86)
|
||||||
|
* [aarch64](https://gitlab.com/api/v4/projects/21018340/jobs/artifacts/main/raw/signaldctl?job=build%3Aaarch64)
|
||||||
|
|
||||||
To register a new account:
|
or build it yourself:
|
||||||
|
|
||||||
```
|
```
|
||||||
signaldctl account create --request-code --phone-number +15555555555
|
go get gitlab.com/signald/signald-go/cmd/signaldctl
|
||||||
```
|
```
|
||||||
|
|
||||||
you will receive an SMS verification code. Submit the code to create the account:
|
# Use
|
||||||
|
|
||||||
```
|
[see in progress documentation site](https://signald.gitlab.io/signald-go/signaldctl/)
|
||||||
signaldctl account create --verify --phone-number +15555555555 --code 999-999
|
|
||||||
```
|
|
||||||
|
|
||||||
## Sending messages
|
|
||||||
|
|
||||||
```
|
|
||||||
signaldctl message send --account +15555555555 --to +12024561414 --message "yo"
|
|
||||||
```
|
|
||||||
|
|
||||||
`--to` can also be a group ID
|
|
Loading…
Reference in a new issue