cli.go

package main

import (
	"os"

	"github.com/urfave/cli/v2"
)

// Init starts the CLI and determines flags
func Init() {

	app := &cli.App{
		Name:    "meshtastic-go",
		Version: "v0.2",
		Authors: []*cli.Author{
			{
				Name: "Lucas Matte",
			},
		},
		Usage: "Interface with meshtastic radios",
		Commands: []*cli.Command{
			{
				Name:        "info",
				Usage:       "Show radio information",
				UsageText:   "info [command] - Show radio information",
				Description: "Show node, preference and channel information for radio",
				ArgsUsage:   "",
				Action:      showAllRadioInfo,
				Flags: []cli.Flag{
					&cli.BoolFlag{
						Name:     "json",
						Usage:    "Output data in JSON",
						Required: false,
					},
				},
				Subcommands: []*cli.Command{
					{
						Name:    "radio",
						Aliases: []string{"r"},
						Usage:   "Show radio information",
						Action:  showRadioInfo,
					},
					{
						Name:    "channels",
						Aliases: []string{"c"},
						Usage:   "Show all channel information",
						Action:  showChannelInfo,
					},
					{
						Name:    "nodes",
						Aliases: []string{"n"},
						Usage:   "Show all nodes on the mesh",
						Action:  showNodeInfo,
					},
					{
						Name:    "position",
						Aliases: []string{"p"},
						Usage:   "Show position settings",
						Action:  showPositionInfo,
					},
					{
						Name:    "metrics",
						Aliases: []string{"m"},
						Usage:   "Display node metrics",
						Action:  showMetricInfo,
					},
				},
			},
			{
				Name:        "message",
				Usage:       "Interact with radio messaging functionality",
				UsageText:   "message [command]",
				Description: "Send messages to other radios or wait for new messages",
				ArgsUsage:   "",
				Subcommands: []*cli.Command{
					{
						Name:        "send",
						Usage:       "Send a text message",
						UsageText:   "text - Sends a text message to a node",
						Description: "Sends a text message to a Node, or to all nodes if no address is provided",
						Action:      sendText,
						Flags: []cli.Flag{
							&cli.StringFlag{
								Name:     "message",
								Aliases:  []string{"m"},
								Usage:    "Message to send, must be under 237 characters",
								Required: true,
							},
							&cli.Int64Flag{
								Name:    "to",
								Aliases: []string{"t"},
								Usage:   "Address to send to. Leave blank for broadcast",
								Value:   0,
							},
							&cli.Int64Flag{
								Name:    "channel",
								Aliases: []string{"c"},
								Usage:   "Channel to send the message on",
								Value:   0,
							},
						},
					},
					{
						Name:        "recv",
						Usage:       "Wait for new messages",
						Description: "Waits for new messages and displays them as received until cancelled. Only shows messages on TEXT_MESSAGE port. Doesn't work over TCP",
						Action:      getReceivedMessages,
						Flags: []cli.Flag{
							&cli.Int64Flag{
								Name:    "channel",
								Aliases: []string{"c"},
								Usage:   "Channel to listen for messages on",
								Value:   0,
							},
							&cli.BoolFlag{
								Name:     "json",
								Usage:    "Output messages in JSON with a newline between each message",
								Required: false,
							},
							&cli.BoolFlag{
								Name:     "exit",
								Aliases:  []string{"e"},
								Usage:    "Exit after receiving a message from the mesh",
								Required: false,
								Value:    false,
							},
						},
					},
				},
			},
			{
				Name:        "channel",
				Usage:       "Update channel information",
				UsageText:   "channel [command] - Update channel parameters",
				Description: "Add, delete and update channel settings",
				ArgsUsage:   "",
				Action:      showChannelInfo,
				Subcommands: []*cli.Command{
					{
						Name:        "url",
						Usage:       "Change settings with a url",
						UsageText:   "url - change settings with url",
						Description: "Set channel settings on radio using a meshtastic URL",
						Action:      setUrl,
						Flags: []cli.Flag{
							&cli.StringFlag{
								Name:     "url",
								Aliases:  []string{"u"},
								Usage:    "Meshtastic channel URL to use",
								Required: true,
							},
						},
					},
					{
						Name:        "add",
						Usage:       "Adds a channel",
						UsageText:   "add - Add a channel to the radio",
						Description: "Add a channel to the radio with a random PSK",
						Action:      addChannel,
						Flags: []cli.Flag{
							&cli.Int64Flag{
								Name:        "index",
								Aliases:     []string{"i"},
								Usage:       "Index for the channel to be added. If a channel is added at 0 it will become the Primary channel",
								Value:       1,
								DefaultText: "1",
								Required:    true,
							},
							&cli.StringFlag{
								Name:     "name",
								Aliases:  []string{"n"},
								Usage:    "Name of the chanel",
								Required: true,
							},
						},
					},
					{
						Name:        "delete",
						Usage:       "Deletes a channel",
						UsageText:   "delete - Delete a channel to the radio",
						Description: "Delete a channel from the radio. Cannot delete a PRIMARY channel",
						Action:      deleteChannel,
						Flags: []cli.Flag{
							&cli.StringFlag{
								Name:     "index",
								Aliases:  []string{"i"},
								Usage:    "Index for the channel to be added. If a channel is added at 0 it will become the Primary channel",
								Required: true,
							},
						},
					},
					{
						Name:        "set",
						Usage:       "Set a channel parameter",
						Description: "Sets channel parameters for the specified channel index",
						Action:      setChannel,
						Flags: []cli.Flag{
							&cli.Int64Flag{
								Name:        "index",
								Aliases:     []string{"i"},
								Usage:       "Index for the channel to be added. If a channel is added at 0 it will become the Primary channel",
								Required:    true,
								Value:       1,
								DefaultText: "1",
							},
							&cli.StringFlag{
								Name:     "key",
								Aliases:  []string{"k"},
								Usage:    "Key of the channel parameter to be changed",
								Required: true,
							},
							&cli.StringFlag{
								Name:     "value",
								Aliases:  []string{"v"},
								Usage:    "Value of the parameter",
								Required: true,
							},
						},
					},
					{
						Name:        "options",
						Usage:       "Show channel options",
						Description: "Show all avaible channel options that can be set",
						Action:      showChannelOptions,
					},
				},
			},
			{
				Name:        "config",
				Usage:       "Update radio config",
				UsageText:   "config [command] - Update radio config",
				Description: "Update radio config",
				ArgsUsage:   "",
				Action:      showRadioConfig,
				Subcommands: []*cli.Command{
					{
						Name:        "set",
						Usage:       "Set a user preference",
						Description: "Sets a user preference using the provided key/value combination",
						Action:      setConfig,
						Flags: []cli.Flag{
							&cli.StringFlag{
								Name:     "key",
								Aliases:  []string{"k"},
								Usage:    "Key of the user preferences to be changed",
								Required: true,
							},
							&cli.StringFlag{
								Name:     "value",
								Aliases:  []string{"v"},
								Usage:    "Value of the parameter",
								Required: true,
							},
						},
					},
					{
						Name:        "owner",
						Usage:       "Set the radio owner",
						Description: "Sets the owner of the radio that is sent out over the network",
						Action:      setOwner,
						Flags: []cli.Flag{
							&cli.StringFlag{
								Name:     "name",
								Aliases:  []string{"n"},
								Usage:    "The owner name",
								Required: true,
							},
						},
					},
				},
			},
			{
				Name:        "location",
				Usage:       "Set location",
				UsageText:   "location [command] - Set location",
				Description: "Manually set GPS coordinates using int values for lat, long, and alt",
				ArgsUsage:   "",
				Subcommands: []*cli.Command{
					{
						Name:        "set",
						Usage:       "Set a location",
						Description: "Manually set GPS coordinates using int values for lat, long, and alt",
						Action:      setLocation,
						Flags: []cli.Flag{
							&cli.Int64Flag{
								Name:     "lat",
								Usage:    "Latitude",
								Required: true,
							},
							&cli.Int64Flag{
								Name:     "long",
								Usage:    "Longitude",
								Required: true,
							},
							&cli.IntFlag{
								Name:     "alt",
								Usage:    "Altitude",
								Required: true,
							},
						},
					},
				},
			},
			{
				Name:        "reset",
				Usage:       "Factory reset the radio",
				UsageText:   "reset - Factory reset the radio",
				Description: "Reset the radio to default settings",
				ArgsUsage:   "",
				Action:      factoryResetRadio,
			},
			{
				Name:        "modem",
				Usage:       "Set the modem mode",
				UsageText:   "modem [command] - set modem mode",
				Description: "Set the modem mode for the radio",
				ArgsUsage:   "",
				Action:      factoryResetRadio,
				Subcommands: []*cli.Command{
					{
						Name:        "options",
						Usage:       "show modem options",
						Description: "Show available modem options",
						Action:      showModemOptions,
					},
					{
						Name:        "set",
						Usage:       "set a modem option",
						Description: "Set the modem",
						Action:      setModemOption,
						Flags: []cli.Flag{
							&cli.StringFlag{
								Name:     "option",
								Aliases:  []string{"o"},
								Usage:    "The modem option",
								Required: true,
							},
						},
					},
				},
			},
		},
		Flags: []cli.Flag{
			&cli.StringFlag{
				Name:    "port",
				Aliases: []string{"p"},
				Usage:   "specify a port",
			},
		},
	}

	app.Run(os.Args)

}