Help us shape the future of Go! Take the 2026 Go Developer Survey

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

ipc

package

Go to main page

Versions in this module

v0

v0.1.0

Oct 19, 2026

Changes in this version

+ const CodeConnLost

+ const CodeDenied

+ const CodeInternal

+ const CodeInvalidParams

+ const CodeInvalidRequest

+ const CodeMethodNotFound

+ const CodeNoSuchPlan

+ const CodeParseError

+ const CodePolicyPending

+ const CodeRefused

+ const CodeTimeout

+ const MaxMessage

+ const MethodChangeRequest

+ const MethodHello

+ const MethodLogout

+ const MethodPIIAdd

+ const MethodPIIList

+ const MethodStatus

+ const ProtocolMajor

+ var ErrAlreadyRunning = errors.New("ipc: a console is already running for this profile")

+ var ErrTooLarge = errors.New("ipc: message larger than 1 MiB")

+ var ErrUnsupported = errors.New("not supported on Windows: run it inside WSL2") — windows/amd64

+ func Compatible(major int) bool

+ func Listen(path string) (net.Listener, error)

+ func ListenShared(kit.Product, string, int) (net.Listener, error) — windows/amd64

+ func ListenShared(p kit.Product, path string, gid int) (net.Listener, error) — darwin/amd64, linux/amd64

+ func PeerAllowed(c net.Conn) (bool, error) — darwin/amd64, linux/amd64

+ func PeerAllowed(net.Conn) (bool, error) — windows/amd64

+ func ReadMsg(r *bufio.Reader, v any) error

+ func SharedSocketPath(dir, projectHash, profile string) (string, error)

+ func SocketPath(p kit.Product, projectHash, profile string) (string, error)

+ func WriteMsg(w io.Writer, v any) error

+ type ChangeParams struct

+ Change string

+ type ChangeResult struct

+ Queued bool

+ type Cred struct

+ GID int

+ PID int

+ UID int

+ func PeerCred(c net.Conn) (Cred, error)

+ func PeerCred(net.Conn) (Cred, error)

+ type HelloParams struct

+ Client string

+ ProtocolMajor int

+ type HelloResult struct

+ ConsoleVersion string

+ Profile string

+ ProtocolMajor int

+ type PIIAddParams struct

+ Pattern string

+ type PIIListResult struct

+ Allow []string

+ Mask []string

+ type RPCError struct

+ Code int

+ Data *refusal.Info

+ Message string

+ func (e *RPCError) Error() string

+ type Request struct

+ ID int64

+ JSONRPC string

+ Method string

+ Params json.RawMessage

+ type Response struct

+ Error *RPCError

+ ID int64

+ JSONRPC string

+ Result json.RawMessage