Add generated documentation
This commit is contained in:
parent
fb3261f811
commit
1b1ade7170
31 changed files with 891 additions and 1 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -1,4 +1,5 @@
|
|||
/signaldctl
|
||||
docs/public
|
||||
|
||||
# Binaries for programs and plugins
|
||||
*.exe
|
||||
|
|
|
@ -86,4 +86,20 @@ publish:
|
|||
DISTRIBUTION: unstable
|
||||
only:
|
||||
- main
|
||||
- tags
|
||||
- tags
|
||||
|
||||
pages:
|
||||
image: debian:latest
|
||||
stage: publish
|
||||
needs: ["build:x86"]
|
||||
before_script:
|
||||
- apt-get update && apt-get install -y hugo
|
||||
script:
|
||||
- ./signaldctl doc
|
||||
- cd docs
|
||||
- hugo
|
||||
- mv public ../
|
||||
artifacts:
|
||||
paths:
|
||||
- "public/"
|
||||
expire_in: 1 month
|
65
cmd/signaldctl/cmd/doc.go
Normal file
65
cmd/signaldctl/cmd/doc.go
Normal file
|
@ -0,0 +1,65 @@
|
|||
// Copyright © 2021 Finn Herzfeld <finn@janky.solutions>
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package cmd
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"path"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
"github.com/spf13/cobra/doc"
|
||||
)
|
||||
|
||||
var DocCmd = &cobra.Command{
|
||||
Use: "doc",
|
||||
Aliases: []string{"docs"},
|
||||
Hidden: true,
|
||||
Run: func(_ *cobra.Command, _ []string) {
|
||||
err := doc.GenMarkdownTreeCustom(RootCmd, "./docs/content/signaldctl", filePrepender, linkHandler)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
func init() {
|
||||
RootCmd.AddCommand(DocCmd)
|
||||
}
|
||||
|
||||
const fmTemplate = `---
|
||||
date: %s
|
||||
title: "%s"
|
||||
slug: %s
|
||||
url: %s
|
||||
---
|
||||
`
|
||||
|
||||
func filePrepender(filename string) string {
|
||||
now := time.Now().Format(time.RFC3339)
|
||||
name := filepath.Base(filename)
|
||||
base := strings.TrimSuffix(name, path.Ext(name))
|
||||
url := "/signaldctl/" + strings.ToLower(base)
|
||||
return fmt.Sprintf(fmTemplate, now, strings.Replace(base, "_", " ", -1), base, url)
|
||||
}
|
||||
|
||||
func linkHandler(name string) string {
|
||||
base := strings.TrimSuffix(name, path.Ext(name))
|
||||
return "/signaldctl/" + strings.ToLower(base)
|
||||
}
|
6
docs/archetypes/default.md
Normal file
6
docs/archetypes/default.md
Normal file
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: "{{ replace .Name "-" " " | title }}"
|
||||
date: {{ .Date }}
|
||||
draft: true
|
||||
---
|
||||
|
3
docs/config.toml
Normal file
3
docs/config.toml
Normal file
|
@ -0,0 +1,3 @@
|
|||
baseURL = "http://signaldctl.signald.org/"
|
||||
languageCode = "en-us"
|
||||
title = "signaldctl"
|
1
docs/content/_index.md
Normal file
1
docs/content/_index.md
Normal file
|
@ -0,0 +1 @@
|
|||
[signaldctl docs are here](/signaldctl/)
|
33
docs/content/signaldctl/signaldctl.md
Normal file
33
docs/content/signaldctl/signaldctl.md
Normal file
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl"
|
||||
slug: signaldctl
|
||||
url: /signaldctl/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 is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl_account) -
|
||||
* [signaldctl config](/signaldctl/signaldctl_config) -
|
||||
* [signaldctl device](/signaldctl/signaldctl_device) -
|
||||
* [signaldctl group](/signaldctl/signaldctl_group) -
|
||||
* [signaldctl message](/signaldctl/signaldctl_message) -
|
||||
* [signaldctl version](/signaldctl/signaldctl_version) - print the current signald and signaldctl version
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
37
docs/content/signaldctl/signaldctl_account.md
Normal file
37
docs/content/signaldctl/signaldctl_account.md
Normal file
|
@ -0,0 +1,37 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl account"
|
||||
slug: signaldctl_account
|
||||
url: /signaldctl/signaldctl_account
|
||||
---
|
||||
## signaldctl account
|
||||
|
||||
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for account
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl) - Interact with a running siangld instance
|
||||
* [signaldctl account link](/signaldctl/signaldctl_account_link) - create a local account by linking to an existing Signal account
|
||||
* [signaldctl account list](/signaldctl/signaldctl_account_list) - return a list of accounts
|
||||
* [signaldctl account register](/signaldctl/signaldctl_account_register) - begin the process of creating a new account
|
||||
* [signaldctl account verify](/signaldctl/signaldctl_account_verify) - verify an account and complete the registration process
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
38
docs/content/signaldctl/signaldctl_account_link.md
Normal file
38
docs/content/signaldctl/signaldctl_account_link.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl account link"
|
||||
slug: signaldctl_account_link
|
||||
url: /signaldctl/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 is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl_account) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
37
docs/content/signaldctl/signaldctl_account_list.md
Normal file
37
docs/content/signaldctl/signaldctl_account_list.md
Normal file
|
@ -0,0 +1,37 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl account list"
|
||||
slug: signaldctl_account_list
|
||||
url: /signaldctl/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 is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl_account) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
39
docs/content/signaldctl/signaldctl_account_register.md
Normal file
39
docs/content/signaldctl/signaldctl_account_register.md
Normal file
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl account register"
|
||||
slug: signaldctl_account_register
|
||||
url: /signaldctl/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 is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl_account) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
39
docs/content/signaldctl/signaldctl_account_verify.md
Normal file
39
docs/content/signaldctl/signaldctl_account_verify.md
Normal file
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl account verify"
|
||||
slug: signaldctl_account_verify
|
||||
url: /signaldctl/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 is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl_account) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
34
docs/content/signaldctl/signaldctl_config.md
Normal file
34
docs/content/signaldctl/signaldctl_config.md
Normal file
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl config"
|
||||
slug: signaldctl_config
|
||||
url: /signaldctl/signaldctl_config
|
||||
---
|
||||
## signaldctl config
|
||||
|
||||
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for config
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl) - Interact with a running siangld instance
|
||||
* [signaldctl config set](/signaldctl/signaldctl_config_set) - send a message
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
37
docs/content/signaldctl/signaldctl_config_set.md
Normal file
37
docs/content/signaldctl/signaldctl_config_set.md
Normal file
|
@ -0,0 +1,37 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl config set"
|
||||
slug: signaldctl_config_set
|
||||
url: /signaldctl/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 is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl_config) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
35
docs/content/signaldctl/signaldctl_device.md
Normal file
35
docs/content/signaldctl/signaldctl_device.md
Normal file
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl device"
|
||||
slug: signaldctl_device
|
||||
url: /signaldctl/signaldctl_device
|
||||
---
|
||||
## signaldctl device
|
||||
|
||||
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for device
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl) - Interact with a running siangld instance
|
||||
* [signaldctl device list](/signaldctl/signaldctl_device_list) - list all devices linked to the account
|
||||
* [signaldctl device remove](/signaldctl/signaldctl_device_remove) - remove a linked device
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
37
docs/content/signaldctl/signaldctl_device_list.md
Normal file
37
docs/content/signaldctl/signaldctl_device_list.md
Normal file
|
@ -0,0 +1,37 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl device list"
|
||||
slug: signaldctl_device_list
|
||||
url: /signaldctl/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 is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl_device) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
39
docs/content/signaldctl/signaldctl_device_remove.md
Normal file
39
docs/content/signaldctl/signaldctl_device_remove.md
Normal file
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl device remove"
|
||||
slug: signaldctl_device_remove
|
||||
url: /signaldctl/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 is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl_device) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
36
docs/content/signaldctl/signaldctl_group.md
Normal file
36
docs/content/signaldctl/signaldctl_group.md
Normal file
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl group"
|
||||
slug: signaldctl_group
|
||||
url: /signaldctl/signaldctl_group
|
||||
---
|
||||
## signaldctl group
|
||||
|
||||
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for group
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl) - Interact with a running siangld instance
|
||||
* [signaldctl group accept](/signaldctl/signaldctl_group_accept) - accept an invitation to join a group
|
||||
* [signaldctl group list](/signaldctl/signaldctl_group_list) - return a list of Signal groups
|
||||
* [signaldctl group show](/signaldctl/signaldctl_group_show) - show details about a group
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
38
docs/content/signaldctl/signaldctl_group_accept.md
Normal file
38
docs/content/signaldctl/signaldctl_group_accept.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl group accept"
|
||||
slug: signaldctl_group_accept
|
||||
url: /signaldctl/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 is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl_group) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
38
docs/content/signaldctl/signaldctl_group_list.md
Normal file
38
docs/content/signaldctl/signaldctl_group_list.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl group list"
|
||||
slug: signaldctl_group_list
|
||||
url: /signaldctl/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 is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl_group) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
38
docs/content/signaldctl/signaldctl_group_show.md
Normal file
38
docs/content/signaldctl/signaldctl_group_show.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl group show"
|
||||
slug: signaldctl_group_show
|
||||
url: /signaldctl/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 is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl_group) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
36
docs/content/signaldctl/signaldctl_message.md
Normal file
36
docs/content/signaldctl/signaldctl_message.md
Normal file
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl message"
|
||||
slug: signaldctl_message
|
||||
url: /signaldctl/signaldctl_message
|
||||
---
|
||||
## signaldctl message
|
||||
|
||||
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for message
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl) - Interact with a running siangld instance
|
||||
* [signaldctl message mark-read](/signaldctl/signaldctl_message_mark-read) - mark a message as read
|
||||
* [signaldctl message react](/signaldctl/signaldctl_message_react) - react to a message
|
||||
* [signaldctl message send](/signaldctl/signaldctl_message_send) - send a message
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
38
docs/content/signaldctl/signaldctl_message_mark-read.md
Normal file
38
docs/content/signaldctl/signaldctl_message_mark-read.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl message mark-read"
|
||||
slug: signaldctl_message_mark-read
|
||||
url: /signaldctl/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 is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl_message) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
42
docs/content/signaldctl/signaldctl_message_react.md
Normal file
42
docs/content/signaldctl/signaldctl_message_react.md
Normal file
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl message react"
|
||||
slug: signaldctl_message_react
|
||||
url: /signaldctl/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 is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl_message) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
40
docs/content/signaldctl/signaldctl_message_send.md
Normal file
40
docs/content/signaldctl/signaldctl_message_send.md
Normal file
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl message send"
|
||||
slug: signaldctl_message_send
|
||||
url: /signaldctl/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 is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl_message) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
37
docs/content/signaldctl/signaldctl_version.md
Normal file
37
docs/content/signaldctl/signaldctl_version.md
Normal file
|
@ -0,0 +1,37 @@
|
|||
---
|
||||
date: 2021-02-02T13:20:04-08:00
|
||||
title: "signaldctl version"
|
||||
slug: signaldctl_version
|
||||
url: /signaldctl/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 is ~/.config/signaldctl.yaml) (default "/home/finn/.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](/signaldctl/signaldctl) - Interact with a running siangld instance
|
||||
|
||||
###### Auto generated by spf13/cobra on 2-Feb-2021
|
16
docs/layouts/_default/baseof.html
Normal file
16
docs/layouts/_default/baseof.html
Normal file
|
@ -0,0 +1,16 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>{{ block "title" . }}{{ .Site.Title }}{{ end }}</title>
|
||||
</head>
|
||||
<body>
|
||||
<!-- Code that all your templates share, like a header -->
|
||||
{{ block "main" . }}
|
||||
<!-- The part of the page that begins to differ between templates -->
|
||||
{{ end }}
|
||||
{{ block "footer" . }}
|
||||
<!-- More shared code, perhaps a footer but that can be overridden if need be in -->
|
||||
{{ end }}
|
||||
</body>
|
||||
</html>
|
6
docs/layouts/_default/list.html
Normal file
6
docs/layouts/_default/list.html
Normal file
|
@ -0,0 +1,6 @@
|
|||
|
||||
{{ define "main" }}
|
||||
<ul>
|
||||
{{ range .Pages }}<li><a href="{{ .URL }}">{{ .Title }}</a></li>
|
||||
{{ end }}
|
||||
{{ end }}
|
6
docs/layouts/_default/single.html
Normal file
6
docs/layouts/_default/single.html
Normal file
|
@ -0,0 +1,6 @@
|
|||
|
||||
{{ define "title" }}{{ .Site.Title }} | {{ .Title }}{{ end }}
|
||||
{{ define "main" }}
|
||||
<h1>{{ .Title }}</h1>
|
||||
{{ .Content }}
|
||||
{{ end }}
|
19
docs/layouts/index.html
Normal file
19
docs/layouts/index.html
Normal file
|
@ -0,0 +1,19 @@
|
|||
{{ define "main" }}
|
||||
<main aria-role="main">
|
||||
<header class="homepage-header">
|
||||
<h1>{{.Title}}</h1>
|
||||
{{ with .Params.subtitle }}
|
||||
<span class="subtitle">{{.}}</span>
|
||||
{{ end }}
|
||||
</header>
|
||||
<div class="homepage-content">
|
||||
<!-- Note that the content for index.html, as a sort of list page, will pull from content/_index.md -->
|
||||
{{.Content}}
|
||||
</div>
|
||||
<div>
|
||||
{{ range first 10 .Site.RegularPages }}
|
||||
{{ .Render "summary"}}
|
||||
{{ end }}
|
||||
</div>
|
||||
</main>
|
||||
{{ end }}
|
3
go.sum
3
go.sum
|
@ -14,6 +14,7 @@ github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc
|
|||
github.com/coreos/go-semver v0.2.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk=
|
||||
github.com/coreos/go-systemd v0.0.0-20190321100706-95778dfbb74e/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4=
|
||||
github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f/go.mod h1:E3G3o1h8I7cfcXa63jLwjI0eiQQMgzzUDFVpN/nH/eA=
|
||||
github.com/cpuguy83/go-md2man/v2 v2.0.0 h1:EoUDS0afbrsXAZ9YQ9jdu/mZ2sXgT1/2yyNng4PGlyM=
|
||||
github.com/cpuguy83/go-md2man/v2 v2.0.0/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
|
||||
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
|
||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
|
@ -94,7 +95,9 @@ github.com/prometheus/tsdb v0.7.1/go.mod h1:qhTCs0VvXwvX/y3TZrWD7rabWM+ijKTux40T
|
|||
github.com/rivo/uniseg v0.1.0 h1:+2KBaVoUmb9XzDsrx/Ct0W/EYOSFf/nWTauy++DprtY=
|
||||
github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
|
||||
github.com/rogpeppe/fastuuid v0.0.0-20150106093220-6724a57986af/go.mod h1:XWv6SoW27p1b0cqNHllgS5HIMJraePCO15w5zCzIWYg=
|
||||
github.com/russross/blackfriday/v2 v2.0.1 h1:lPqVAte+HuHNfhJ/0LC98ESWRz8afy9tM/0RK8m9o+Q=
|
||||
github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
|
||||
github.com/shurcooL/sanitized_anchor_name v1.0.0 h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo=
|
||||
github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
|
||||
github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo=
|
||||
github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4kGIyLM=
|
||||
|
|
Loading…
Reference in a new issue