Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

client

package

Go to main page

Versions in this module

v0

v0.31.0

Aug 10, 2026

Changes in this version

+ type MTLSConfig struct

+ CertMount string

+ CertRole string

+ StorageDir string

type VaultConfig

+ MTLS MTLSConfig

v0.30.0

Aug 6, 2026

Changes in this version

type Client

+ func (c *Client) Clipboard(ctx context.Context, text string) error

type VaultConfig

+ APISocket string

v0.29.0

Jul 23, 2026

Changes in this version

+ var ErrPeerUnavailable = errors.New("dotvault: peer action unavailable")

type Client

+ func (c *Client) Browse(ctx context.Context, rawURL string) error

+ func (c *Client) Notify(ctx context.Context, level, title, body, actionURL string) error

v0.28.0

Jul 10, 2026

v0.27.0

Jul 2, 2026

v0.26.0

Jul 1, 2026

Changes in this version

type VaultConfig

+ OIDCCallbackPort int

v0.25.0

Jun 23, 2026

Changes in this version

type VaultConfig

+ NoDefaultPolicy bool

+ Policies []string

v0.24.0

Jun 19, 2026

Changes in this version

type VaultConfig

+ TokenSocket string

v0.23.0

Jun 18, 2026

v0.22.0

Jun 14, 2026

v0.21.0

Jun 9, 2026

v0.20.0

Jun 5, 2026

v0.19.0

May 31, 2026

v0.18.0

May 30, 2026

Changes in this version

+ var ErrAuthFailed = errors.New("dotvault: authentication failed")

+ var ErrDenied = errors.New("dotvault: vault denied the request")

+ var ErrLoginRequired = errors.New("dotvault: login required (no valid cached token)")

+ var ErrUnreachable = errors.New("dotvault: vault unreachable")

+ func DefaultConfigPath() string

+ func DefaultTokenFile() (path string)

+ type Client struct

+ func New(cfg *Config, opts ...Option) (*Client, error)

+ func (c *Client) Authenticate(ctx context.Context) error

+ func (c *Client) AuthenticateCached(ctx context.Context) error

+ func (c *Client) IdentityName() (string, error)

+ func (c *Client) Login(ctx context.Context) error

+ func (c *Client) ReadKVField(ctx context.Context, mount, path, field string) (string, bool, error)

+ func (c *Client) ReadUserSecret(ctx context.Context, service, field string) (string, bool, error)

+ func (c *Client) Token() string

+ type Config struct

+ TokenFile string

+ Vault VaultConfig

+ func LoadConfig(path string) (*Config, error)

+ type Option func(*Client)

+ func WithIdentity(name string) Option

+ type Reader interface

+ IdentityName func() (string, error)

+ ReadKVField func(ctx context.Context, mount, path, field string) (string, bool, error)

+ ReadUserSecret func(ctx context.Context, service, field string) (string, bool, error)

+ type VaultConfig struct

+ Address string

+ AuthMethod string

+ AuthMount string

+ AuthRole string

+ CACert string

+ KVMount string

+ TLSSkipVerify bool

+ UserPrefix string