uncommit generated markdown files

This commit is contained in:
Finn 2021-02-02 16:36:01 -08:00
parent ee3122f293
commit 82527e7703
22 changed files with 2 additions and 728 deletions

1
.gitignore vendored
View file

@ -1,5 +1,6 @@
/signaldctl
docs/public
docs/content/signaldctl
# Binaries for programs and plugins
*.exe

View file

@ -95,6 +95,7 @@ pages:
before_script:
- apt-get update && apt-get install -y hugo
script:
- mkdir -p docs/content/signaldctl
- SIGNALDCTL_PUBLIC_DOC_MODE=on ./signaldctl doc
- cd docs
- hugo

View file

@ -1,32 +0,0 @@
---
title: "signaldctl"
slug: signaldctl
url: signaldctl
---
## signaldctl
Interact with a running siangld instance
### Synopsis
signaldctl is a command line tool to interact with signald.
### Options
```
--config string config file (default "~/.config/signaldctl.yaml")
-h, --help help for signaldctl
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl account](/signald-go/signaldctl_account) -
* [signaldctl config](/signald-go/signaldctl_config) -
* [signaldctl device](/signald-go/signaldctl_device) -
* [signaldctl group](/signald-go/signaldctl_group) -
* [signaldctl message](/signald-go/signaldctl_message) -
* [signaldctl version](/signald-go/signaldctl_version) - print the current signald and signaldctl version
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,36 +0,0 @@
---
title: "signaldctl account"
slug: signaldctl_account
url: signaldctl_account
---
## signaldctl account
### Synopsis
### Options
```
-h, --help help for account
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl](/signald-go/signaldctl) - Interact with a running siangld instance
* [signaldctl account link](/signald-go/signaldctl_account_link) - create a local account by linking to an existing Signal account
* [signaldctl account list](/signald-go/signaldctl_account_list) - return a list of accounts
* [signaldctl account register](/signald-go/signaldctl_account_register) - begin the process of creating a new account
* [signaldctl account verify](/signald-go/signaldctl_account_verify) - verify an account and complete the registration process
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,37 +0,0 @@
---
title: "signaldctl account link"
slug: signaldctl_account_link
url: signaldctl_account_link
---
## signaldctl account link
create a local account by linking to an existing Signal account
### Synopsis
create a local account by linking to an existing Signal account
```
signaldctl account link [flags]
```
### Options
```
-h, --help help for link
--no-wait return after the linking URI is printed to stdout. By default, signaldctl will wait until the server acknowledges that the linking has completed before exiting
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl account](/signald-go/signaldctl_account) -
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,36 +0,0 @@
---
title: "signaldctl account list"
slug: signaldctl_account_list
url: signaldctl_account_list
---
## signaldctl account list
return a list of accounts
### Synopsis
return a list of accounts
```
signaldctl account list [flags]
```
### Options
```
-h, --help help for list
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl account](/signald-go/signaldctl_account) -
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,38 +0,0 @@
---
title: "signaldctl account register"
slug: signaldctl_account_register
url: signaldctl_account_register
---
## signaldctl account register
begin the process of creating a new account
### Synopsis
begin the process of creating a new account
```
signaldctl account register [flags]
```
### Options
```
-h, --help help for register
-n, --number string phone number being registered
-V, --voice request verification code be sent via an automated voice call (code is sent via SMS by default)
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl account](/signald-go/signaldctl_account) -
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,38 +0,0 @@
---
title: "signaldctl account verify"
slug: signaldctl_account_verify
url: signaldctl_account_verify
---
## signaldctl account verify
verify an account and complete the registration process
### Synopsis
verify an account and complete the registration process
```
signaldctl account verify [flags]
```
### Options
```
-c, --code string verification code to submit
-h, --help help for verify
-n, --phone-number string phone number being verified
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl account](/signald-go/signaldctl_account) -
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,33 +0,0 @@
---
title: "signaldctl config"
slug: signaldctl_config
url: signaldctl_config
---
## signaldctl config
### Synopsis
### Options
```
-h, --help help for config
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl](/signald-go/signaldctl) - Interact with a running siangld instance
* [signaldctl config set](/signald-go/signaldctl_config_set) - send a message
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,36 +0,0 @@
---
title: "signaldctl config set"
slug: signaldctl_config_set
url: signaldctl_config_set
---
## signaldctl config set
send a message
### Synopsis
send a message
```
signaldctl config set [flags]
```
### Options
```
-h, --help help for set
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl config](/signald-go/signaldctl_config) -
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,34 +0,0 @@
---
title: "signaldctl device"
slug: signaldctl_device
url: signaldctl_device
---
## signaldctl device
### Synopsis
### Options
```
-h, --help help for device
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl](/signald-go/signaldctl) - Interact with a running siangld instance
* [signaldctl device list](/signald-go/signaldctl_device_list) - list all devices linked to the account
* [signaldctl device remove](/signald-go/signaldctl_device_remove) - remove a linked device
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,36 +0,0 @@
---
title: "signaldctl device list"
slug: signaldctl_device_list
url: signaldctl_device_list
---
## signaldctl device list
list all devices linked to the account
### Synopsis
list all devices linked to the account
```
signaldctl device list [flags]
```
### Options
```
-h, --help help for list
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl device](/signald-go/signaldctl_device) -
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,38 +0,0 @@
---
title: "signaldctl device remove"
slug: signaldctl_device_remove
url: signaldctl_device_remove
---
## signaldctl device remove
remove a linked device
### Synopsis
remove a linked device
```
signaldctl device remove [flags]
```
### Options
```
-a, --account string local account to use
-d, --device int device ID to remove
-h, --help help for remove
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl device](/signald-go/signaldctl_device) -
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,35 +0,0 @@
---
title: "signaldctl group"
slug: signaldctl_group
url: signaldctl_group
---
## signaldctl group
### Synopsis
### Options
```
-h, --help help for group
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl](/signald-go/signaldctl) - Interact with a running siangld instance
* [signaldctl group accept](/signald-go/signaldctl_group_accept) - accept an invitation to join a group
* [signaldctl group list](/signald-go/signaldctl_group_list) - return a list of Signal groups
* [signaldctl group show](/signald-go/signaldctl_group_show) - show details about a group
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,37 +0,0 @@
---
title: "signaldctl group accept"
slug: signaldctl_group_accept
url: signaldctl_group_accept
---
## signaldctl group accept
accept an invitation to join a group
### Synopsis
accept an invitation to join a group
```
signaldctl group accept [flags]
```
### Options
```
-a, --account string the signald account to use
-h, --help help for accept
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl group](/signald-go/signaldctl_group) -
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,37 +0,0 @@
---
title: "signaldctl group list"
slug: signaldctl_group_list
url: signaldctl_group_list
---
## signaldctl group list
return a list of Signal groups
### Synopsis
return a list of Signal groups
```
signaldctl group list [flags]
```
### Options
```
-a, --account string the signald account to use
-h, --help help for list
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl group](/signald-go/signaldctl_group) -
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,37 +0,0 @@
---
title: "signaldctl group show"
slug: signaldctl_group_show
url: signaldctl_group_show
---
## signaldctl group show
show details about a group
### Synopsis
show details about a group
```
signaldctl group show [flags]
```
### Options
```
-a, --account string the signald account to use
-h, --help help for show
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl group](/signald-go/signaldctl_group) -
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,35 +0,0 @@
---
title: "signaldctl message"
slug: signaldctl_message
url: signaldctl_message
---
## signaldctl message
### Synopsis
### Options
```
-h, --help help for message
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl](/signald-go/signaldctl) - Interact with a running siangld instance
* [signaldctl message mark-read](/signald-go/signaldctl_message_mark-read) - mark a message as read
* [signaldctl message react](/signald-go/signaldctl_message_react) - react to a message
* [signaldctl message send](/signald-go/signaldctl_message_send) - send a message
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,37 +0,0 @@
---
title: "signaldctl message mark-read"
slug: signaldctl_message_mark-read
url: signaldctl_message_mark-read
---
## signaldctl message mark-read
mark a message as read
### Synopsis
mark a message as read
```
signaldctl message mark-read [flags]
```
### Options
```
-a, --account string local account to use
-h, --help help for mark-read
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl message](/signald-go/signaldctl_message) -
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,41 +0,0 @@
---
title: "signaldctl message react"
slug: signaldctl_message_react
url: signaldctl_message_react
---
## signaldctl message react
react to a message
### Synopsis
react to a message
```
signaldctl message react [flags]
```
### Options
```
-a, --account string local account to use
--author string the phone number of the author of the message being reacted to
-h, --help help for react
-r, --remove remove a reaction that was previously set
-w, --timestamp int the timestamp of the message being reacted to
-t, --to string phone number or group ID that the message was sent to
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl message](/signald-go/signaldctl_message) -
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,39 +0,0 @@
---
title: "signaldctl message send"
slug: signaldctl_message_send
url: signaldctl_message_send
---
## signaldctl message send
send a message
### Synopsis
send a message
```
signaldctl message send [flags]
```
### Options
```
-a, --account string local account to use
-h, --help help for send
-m, --message string the body of the message to send
-t, --to string phone number or group ID to send the message to
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl message](/signald-go/signaldctl_message) -
###### Auto generated by spf13/cobra on 2-Feb-2021

View file

@ -1,36 +0,0 @@
---
title: "signaldctl version"
slug: signaldctl_version
url: signaldctl_version
---
## signaldctl version
print the current signald and signaldctl version
### Synopsis
print the current signald and signaldctl version
```
signaldctl version [flags]
```
### Options
```
-h, --help help for version
```
### Options inherited from parent commands
```
--config string config file (default "~/.config/signaldctl.yaml")
-o, --output-format string the output format. options are usually table, yaml and json, default is usually table. Some commands have other options. (default "default")
--socket string the path to the signald socket file (default "/var/run/signald/signald.sock")
```
### SEE ALSO
* [signaldctl](/signald-go/signaldctl) - Interact with a running siangld instance
###### Auto generated by spf13/cobra on 2-Feb-2021