actions

Documentation

Overview

piawgcli Copyright (C) 2021-2023 Derek Battams <derek@battams.ca>

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 <https://www.gnu.org/licenses/>.

piawgcli
Copyright (C) 2021  Derek Battams <derek@battams.ca>

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 <https://www.gnu.org/licenses/>.

Index

• type CreateConfigCmd
  • func (cmd *CreateConfigCmd) Run(state *appstate.State) error
• type ShowRegionsCmd
  • func (cmd *ShowRegionsCmd) Run(state *appstate.State) error

Types

type CreateConfigCmd

type CreateConfigCmd struct {
	PiaId        string `required help:"PIA user id" placeholder:"ID"`
	PiaPassword  string `required help:"PIA password" placeholder:"PWD"`
	PiaRegionId  string `required help:"PIA region id to connect to; use show-regions command to get the region id" placeholder:"ID"`
	IgnorePiaDns bool   `help:"Do not set DNS servers to PIA servers in generated configuration"`
	Output       string `help:"write wg config to file instead of stdout" placeholder:"FILE"`
}

func (*CreateConfigCmd) Run

func (cmd *CreateConfigCmd) Run(state *appstate.State) error

TODO break this down (verify tmpl output, etc)

type ShowRegionsCmd

type ShowRegionsCmd struct {
	CaseSensitive bool   `help:"case sensitive searching" default:"1" negatable`
	Ping          bool   `optional help:"ping each region and sort results by ping time" default:"0"`
	SortBy        string `optional help:"sort results by given field" enum:"id,name" default:"name"`
	SortOrder     string `optional help:"sort results ASCending or DESCending order" enum:"asc,desc" default:"asc"`
	Search        string `optional help:"find regions containing search term"`
	Threads       uint8  `optional help:"max number of worker threads for pinging regions" default:"8"`
	Samples       uint8  `optional help:"number of samples to take when pinging regions" default:"3"`
}

func (*ShowRegionsCmd) Run

func (cmd *ShowRegionsCmd) Run(state *appstate.State) error