netrc

README

go-netrc

A netrc parser for Go.

Usage

Getting credentials for a host.

usr, err := user.Current()
n, err := netrc.Parse(filepath.Join(usr.HomeDir, ".netrc"))
fmt.Println(n.Machine("api.heroku.com").Get("password"))

Setting credentials on a host.

usr, err := user.Current()
n, err := netrc.Parse(filepath.Join(usr.HomeDir, ".netrc"))
n.Machine("api.heroku.com").Set("password", "newapikey")
n.Save()

Documentation

Index

• Variables
• type Machine
  • func (m *Machine) Get(name string) string
  • func (m *Machine) Set(name, value string)
• type Machines
• type Netrc
  • func New(p string) *Netrc
  • func Parse(path string) (*Netrc, error)
  • func ParseString(contents string) (*Netrc, error)
  • func (n *Netrc) AddMachine(name, login, password string)
  • func (n *Netrc) Machine(name string) *Machine
  • func (n *Netrc) Machines() Machines
  • func (n *Netrc) RemoveMachine(name string)
  • func (n *Netrc) Render() string
  • func (n *Netrc) Save() error

Variables

var ErrInvalidNetrc = errors.New("Invalid netrc")

ErrInvalidNetrc means there was an error parsing the netrc file

Types

type Machine

type Machine struct {
	Name      string
	IsDefault bool
	// contains filtered or unexported fields
}

Machine from the netrc file

func (*Machine) Get

func (m *Machine) Get(name string) string

Get a property from a machine

func (*Machine) Set

func (m *Machine) Set(name, value string)

Set a property on the machine

type Machines

type Machines []*Machine

type Netrc

type Netrc struct {
	Path string
	// contains filtered or unexported fields
}

Netrc file

func New

func New(p string) *Netrc

New creates and returns a new empty Netrc for writing to.

func Parse

func Parse(path string) (*Netrc, error)

Parse the netrc file at the given path It returns a Netrc instance

func ParseString

func ParseString(contents string) (*Netrc, error)

ParseString behaves just like Parse, but can be used to parse netrc data without loading it from a file.

func (*Netrc) AddMachine

func (n *Netrc) AddMachine(name, login, password string)

AddMachine adds a machine

func (*Netrc) Machine

func (n *Netrc) Machine(name string) *Machine

Machine gets a machine by name

func (*Netrc) Machines

func (n *Netrc) Machines() Machines

Machine gets a machine by name

func (*Netrc) RemoveMachine

func (n *Netrc) RemoveMachine(name string)

RemoveMachine remove a machine

func (*Netrc) Render

func (n *Netrc) Render() string

Render out the netrc file to a string

func (*Netrc) Save

func (n *Netrc) Save() error

Save the file to disk