diff --git a/.gitignore b/.gitignore index 10f4b32..f21cf80 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ /signaldctl +docs/public # Binaries for programs and plugins *.exe diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 8eb4971..32ea7a0 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -86,4 +86,20 @@ publish: DISTRIBUTION: unstable only: - main - - tags \ No newline at end of file + - 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 \ No newline at end of file diff --git a/cmd/signaldctl/cmd/doc.go b/cmd/signaldctl/cmd/doc.go new file mode 100644 index 0000000..33cc103 --- /dev/null +++ b/cmd/signaldctl/cmd/doc.go @@ -0,0 +1,65 @@ +// Copyright © 2021 Finn Herzfeld +// +// 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 . + +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) +} diff --git a/docs/archetypes/default.md b/docs/archetypes/default.md new file mode 100644 index 0000000..00e77bd --- /dev/null +++ b/docs/archetypes/default.md @@ -0,0 +1,6 @@ +--- +title: "{{ replace .Name "-" " " | title }}" +date: {{ .Date }} +draft: true +--- + diff --git a/docs/config.toml b/docs/config.toml new file mode 100644 index 0000000..b290103 --- /dev/null +++ b/docs/config.toml @@ -0,0 +1,3 @@ +baseURL = "http://signaldctl.signald.org/" +languageCode = "en-us" +title = "signaldctl" diff --git a/docs/content/_index.md b/docs/content/_index.md new file mode 100644 index 0000000..96917a0 --- /dev/null +++ b/docs/content/_index.md @@ -0,0 +1 @@ +[signaldctl docs are here](/signaldctl/) \ No newline at end of file diff --git a/docs/content/signaldctl/signaldctl.md b/docs/content/signaldctl/signaldctl.md new file mode 100644 index 0000000..42d35d9 --- /dev/null +++ b/docs/content/signaldctl/signaldctl.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_account.md b/docs/content/signaldctl/signaldctl_account.md new file mode 100644 index 0000000..5ea90d8 --- /dev/null +++ b/docs/content/signaldctl/signaldctl_account.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_account_link.md b/docs/content/signaldctl/signaldctl_account_link.md new file mode 100644 index 0000000..758f1bd --- /dev/null +++ b/docs/content/signaldctl/signaldctl_account_link.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_account_list.md b/docs/content/signaldctl/signaldctl_account_list.md new file mode 100644 index 0000000..f4e0f96 --- /dev/null +++ b/docs/content/signaldctl/signaldctl_account_list.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_account_register.md b/docs/content/signaldctl/signaldctl_account_register.md new file mode 100644 index 0000000..3b8d93a --- /dev/null +++ b/docs/content/signaldctl/signaldctl_account_register.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_account_verify.md b/docs/content/signaldctl/signaldctl_account_verify.md new file mode 100644 index 0000000..07ac8b6 --- /dev/null +++ b/docs/content/signaldctl/signaldctl_account_verify.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_config.md b/docs/content/signaldctl/signaldctl_config.md new file mode 100644 index 0000000..5e06d4d --- /dev/null +++ b/docs/content/signaldctl/signaldctl_config.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_config_set.md b/docs/content/signaldctl/signaldctl_config_set.md new file mode 100644 index 0000000..08d9186 --- /dev/null +++ b/docs/content/signaldctl/signaldctl_config_set.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_device.md b/docs/content/signaldctl/signaldctl_device.md new file mode 100644 index 0000000..19f087d --- /dev/null +++ b/docs/content/signaldctl/signaldctl_device.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_device_list.md b/docs/content/signaldctl/signaldctl_device_list.md new file mode 100644 index 0000000..08090b0 --- /dev/null +++ b/docs/content/signaldctl/signaldctl_device_list.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_device_remove.md b/docs/content/signaldctl/signaldctl_device_remove.md new file mode 100644 index 0000000..187c702 --- /dev/null +++ b/docs/content/signaldctl/signaldctl_device_remove.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_group.md b/docs/content/signaldctl/signaldctl_group.md new file mode 100644 index 0000000..6a9ba4d --- /dev/null +++ b/docs/content/signaldctl/signaldctl_group.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_group_accept.md b/docs/content/signaldctl/signaldctl_group_accept.md new file mode 100644 index 0000000..066a914 --- /dev/null +++ b/docs/content/signaldctl/signaldctl_group_accept.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_group_list.md b/docs/content/signaldctl/signaldctl_group_list.md new file mode 100644 index 0000000..fc675aa --- /dev/null +++ b/docs/content/signaldctl/signaldctl_group_list.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_group_show.md b/docs/content/signaldctl/signaldctl_group_show.md new file mode 100644 index 0000000..0700182 --- /dev/null +++ b/docs/content/signaldctl/signaldctl_group_show.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_message.md b/docs/content/signaldctl/signaldctl_message.md new file mode 100644 index 0000000..7a83593 --- /dev/null +++ b/docs/content/signaldctl/signaldctl_message.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_message_mark-read.md b/docs/content/signaldctl/signaldctl_message_mark-read.md new file mode 100644 index 0000000..458bda9 --- /dev/null +++ b/docs/content/signaldctl/signaldctl_message_mark-read.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_message_react.md b/docs/content/signaldctl/signaldctl_message_react.md new file mode 100644 index 0000000..7954191 --- /dev/null +++ b/docs/content/signaldctl/signaldctl_message_react.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_message_send.md b/docs/content/signaldctl/signaldctl_message_send.md new file mode 100644 index 0000000..e610610 --- /dev/null +++ b/docs/content/signaldctl/signaldctl_message_send.md @@ -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 diff --git a/docs/content/signaldctl/signaldctl_version.md b/docs/content/signaldctl/signaldctl_version.md new file mode 100644 index 0000000..76c34a3 --- /dev/null +++ b/docs/content/signaldctl/signaldctl_version.md @@ -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 diff --git a/docs/layouts/_default/baseof.html b/docs/layouts/_default/baseof.html new file mode 100644 index 0000000..641e694 --- /dev/null +++ b/docs/layouts/_default/baseof.html @@ -0,0 +1,16 @@ + + + + + {{ block "title" . }}{{ .Site.Title }}{{ end }} + + + + {{ block "main" . }} + + {{ end }} + {{ block "footer" . }} + + {{ end }} + + diff --git a/docs/layouts/_default/list.html b/docs/layouts/_default/list.html new file mode 100644 index 0000000..653efff --- /dev/null +++ b/docs/layouts/_default/list.html @@ -0,0 +1,6 @@ + +{{ define "main" }} +