jshiffer/go-xmpp
1
0
Fork 1
mirror of https://github.com/FluuxIO/go-xmpp.git synced 2024-11-21 10:02:00 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix naming from fluxxmpp to fluuxmpp

Browse Source
This commit is contained in:
Martin/Geno 2019-08-06 16:03:48 +02:00 committed by Mickaël Rémond
parent 76f59be5ed
commit 6e65ba2a0b
10 changed files with 37 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
cmd/fluxxmpp/README.md → cmd/fluuxmpp/README.md
View File

@ -1,23 +1,23 @@
# fluxxmpp
# fluuxmpp
fluxxIO's xmpp comandline tool
fluuxIO's xmpp comandline tool
## Installation
To install `fluxxmpp` in your Go path:
To install `fluuxmpp` in your Go path:
```
$ go get -u gosrc.io/xmpp/cmd/fluxxmpp
$ go get -u gosrc.io/xmpp/cmd/fluuxmpp
```
## Usage
```
$ fluxxmpp --help
fluxxIO's xmpp comandline tool
$ fluuxmpp --help
fluuxIO's xmpp comandline tool
Usage:
fluxxmpp [command]
fluuxmpp [command]
Available Commands:
check is a command-line to check if you XMPP TLS certificate is valid and warn you before it expires
@ -25,22 +25,22 @@ Available Commands:
send is a command-line tool to send to send XMPP messages to users
Flags:
-h, --help help for fluxxmpp
-h, --help help for fluuxmpp
Use "fluxxmpp [command] --help" for more information about a command.
Use "fluuxmpp [command] --help" for more information about a command.
```
### check tls
```
$ fluxxmpp check --help
$ fluuxmpp check --help
is a command-line to check if you XMPP TLS certificate is valid and warn you before it expires
Usage:
fluxxmpp check <host[:port]> [flags]
fluuxmpp check <host[:port]> [flags]
Examples:
fluxxmpp check chat.sum7.eu:5222 --domain meckerspace.de
fluuxmpp check chat.sum7.eu:5222 --domain meckerspace.de
Flags:
-d, --domain string domain if host handle multiple domains
@ -50,18 +50,18 @@ Flags:
### sending messages
```
$ fluxxmpp send --help
$ fluuxmpp send --help
is a command-line tool to send to send XMPP messages to users
Usage:
fluxxmpp send <recipient,> [message] [flags]
fluuxmpp send <recipient,> [message] [flags]
Examples:
fluxxmpp send to@chat.sum7.eu "Hello World!"
fluuxmpp send to@chat.sum7.eu "Hello World!"
Flags:
--addr string host[:port]
--config string config file (default is ~/.config/fluxxmpp.yml)
--config string config file (default is ~/.config/fluuxmpp.yml)
-h, --help help for send
--jid string using jid (required)
-m, --muc recipient is a muc (join it before sending messages)
@ -76,7 +76,7 @@ Flags:
If you server is on standard port and XMPP domains matches the hostname you can simply use:
```
$ fluxxmpp check chat.sum7.eu
$ fluuxmpp check chat.sum7.eu
info All checks passed
⇢ address="chat.sum7.eu" domain=""
⇢ main.go:43 main.runCheck
@ -86,7 +86,7 @@ $ fluxxmpp check chat.sum7.eu
You can also pass the port and the XMPP domain if different from the server hostname:
```
$ fluxxmpp check chat.sum7.eu:5222 --domain meckerspace.de
$ fluuxmpp check chat.sum7.eu:5222 --domain meckerspace.de
info All checks passed
⇢ address="chat.sum7.eu:5222" domain="meckerspace.de"
⇢ main.go:43 main.runCheck
@ -101,7 +101,7 @@ monitoring scripts.
Message from arguments:
```bash
$ fluxxmpp send to@example.org "Hello World!"
$ fluuxmpp send to@example.org "Hello World!"
info client connected
⇢ cmd.go:56 main.glob..func1.1
⇢ 2019-07-17T23:42:43.310+02:00
@ -113,7 +113,7 @@ $ fluxxmpp send to@example.org "Hello World!"
Message from STDIN:
```bash
$ journalctl -f | fluxxmpp send to@example.org -
$ journalctl -f | fluuxmpp send to@example.org -
info client connected
⇢ cmd.go:56 main.glob..func1.1
⇢ 2019-07-17T23:40:03.177+02:00
@ -131,7 +131,7 @@ $ journalctl -f | fluxxmpp send to@example.org -
Multiple recipients:
```bash
$ fluxxmpp send to1@example.org,to2@example.org "Multiple recipient"
$ fluuxmpp send to1@example.org,to2@example.org "Multiple recipient"
info client connected
⇢ cmd.go:56 main.glob..func1.1
⇢ 2019-07-17T23:47:57.650+02:00
@ -147,7 +147,7 @@ $ fluxxmpp send to1@example.org,to2@example.org "Multiple recipient"
Send to MUC:
```bash
journalctl -f | fluxxmpp send testit@conference.chat.sum7.eu - --muc
journalctl -f | fluuxmpp send testit@conference.chat.sum7.eu - --muc
info client connected
⇢ cmd.go:56 main.glob..func1.1
⇢ 2019-07-17T23:52:56.269+02:00
@ -167,9 +167,9 @@ journalctl -f | fluxxmpp send testit@conference.chat.sum7.eu - --muc
### Configuration file
In `/etc/`, `~/.config` and `.` (here).
You could create the file name `fluxxmpp` with you favorite file extenion (e.g. `toml`, `yml`).
You could create the file name `fluuxmpp` with you favorite file extenion (e.g. `toml`, `yml`).
e.g. ~/.config/fluxxmpp.toml
e.g. ~/.config/fluuxmpp.toml
```toml
jid = "bot@example.org"
password = "secret"
@ -185,7 +185,7 @@ export FLUXXMPP_PASSWORD='secret';
export FLUXXMPP_ADDR='example.com:5222';
fluxxmpp send to@example.org "Hello Welt";
fluuxmpp send to@example.org "Hello Welt";
```
### Parameters
@ -194,5 +194,5 @@ Warning: This should not be used for production systems, as all users on the sys
can read the running processes, and their parameters (and thus the password).
```bash
fluxxmpp send to@example.org "Hello World!" --jid bot@example.org --password secret --addr example.com:5222;
fluuxmpp send to@example.org "Hello World!" --jid bot@example.org --password secret --addr example.com:5222;
```

0
cmd/fluxxmpp/TODO.md → cmd/fluuxmpp/TODO.md
View File

2
cmd/fluxxmpp/check.go → cmd/fluuxmpp/check.go
View File

@ -10,7 +10,7 @@ var domain = ""
var cmdCheck = &cobra.Command{
Use: "check <host[:port]>",
Short: "is a command-line to check if you XMPP TLS certificate is valid and warn you before it expires",
Example: "fluxxmpp check chat.sum7.eu:5222 --domain meckerspace.de",
Example: "fluuxmpp check chat.sum7.eu:5222 --domain meckerspace.de",
Args: cobra.ExactArgs(1),
Run: func(cmd *cobra.Command, args []string) {
runCheck(args[0], domain)

5
cmd/fluuxmpp/doc.go Normal file
View File

@ -0,0 +1,5 @@
/*
fluuxmpp: fluuxIO's xmpp comandline tool
*/
package main

0
cmd/fluxxmpp/log.go → cmd/fluuxmpp/log.go
View File

4
cmd/fluxxmpp/main.go → cmd/fluuxmpp/main.go
View File

@ -7,8 +7,8 @@ import (
// cmdRoot represents the base command when called without any subcommands
var cmdRoot = &cobra.Command{
Use: "fluxxmpp",
Short: "fluxxIO's xmpp comandline tool",
Use: "fluuxmpp",
Short: "fluuxIO's xmpp comandline tool",
}
func main() {

6
cmd/fluxxmpp/send.go → cmd/fluuxmpp/send.go
View File

@ -21,7 +21,7 @@ var isMUCRecipient = false
var cmdSend = &cobra.Command{
Use: "send <recipient,> [message]",
Short: "is a command-line tool to send to send XMPP messages to users",
Example: `fluxxmpp send to@chat.sum7.eu "Hello World!"`,
Example: `fluuxmpp send to@chat.sum7.eu "Hello World!"`,
Args: cobra.ExactArgs(2),
Run: sendxmpp,
}
@ -99,7 +99,7 @@ func init() {
cmdRoot.AddCommand(cmdSend)
cobra.OnInitialize(initConfigFile)
cmdSend.PersistentFlags().StringVar(&configFile, "config", "", "config file (default is ~/.config/fluxxmpp.yml)")
cmdSend.PersistentFlags().StringVar(&configFile, "config", "", "config file (default is ~/.config/fluuxmpp.yml)")
cmdSend.Flags().StringP("jid", "", "", "using jid (required)")
viper.BindPFlag("jid", cmdSend.Flags().Lookup("jid"))
@ -119,7 +119,7 @@ func initConfigFile() {
viper.SetConfigFile(configFile)
}
viper.SetConfigName("fluxxmpp")
viper.SetConfigName("fluuxmpp")
viper.AddConfigPath("/etc/")
viper.AddConfigPath("$HOME/.config")
viper.AddConfigPath(".")

0
cmd/fluxxmpp/xmppmuc.go → cmd/fluuxmpp/xmppmuc.go
View File

0
cmd/fluxxmpp/xmppsend.go → cmd/fluuxmpp/xmppsend.go
View File

5
cmd/fluxxmpp/doc.go
View File

@ -1,5 +0,0 @@
/*
fluxxmpp: fluxxIO's xmpp comandline tool
*/
package main