browser

README

browser

Helpers to open URLs, readers, or files in the system default web browser.

This fork adds:

• OpenReader error wrapping;
• ErrNotFound error wrapping on BSD;
• Go 1.21 support.

Usage

import "github.com/cli/browser"

err = browser.OpenURL(url)
err = browser.OpenFile(path)
err = browser.OpenReader(reader)

Documentation

Overview

Package browser provides helpers to open files, readers, and urls in a browser window.

The choice of which browser is started is entirely client dependent.

Index

• Variables
• func OpenFile(path string) error
• func OpenReader(r io.Reader) error
• func OpenURL(url string) error

Examples

• OpenFile
• OpenReader
• OpenURL

Variables

var Stderr io.Writer = os.Stderr

Stderr is the io.Writer to which executed commands write standard error.

var Stdout io.Writer = os.Stdout

Stdout is the io.Writer to which executed commands write standard output.

Functions

func OpenFile

func OpenFile(path string) error

OpenFile opens new browser window for the file path.

Example

_ = OpenFile("index.html")

func OpenReader

func OpenReader(r io.Reader) error

OpenReader consumes the contents of r and presents the results in a new browser window.

Example

// https://github.com/rust-lang/rust/issues/13871
const quote = `There was a night when winds from unknown spaces
whirled us irresistibly into limitless vacum beyond all thought and entity.
Perceptions of the most maddeningly untransmissible sort thronged upon us;
perceptions of infinity which at the time convulsed us with joy, yet which
are now partly lost to my memory and partly incapable of presentation to others.`
r := strings.NewReader(quote)
_ = OpenReader(r)

func OpenURL

func OpenURL(url string) error

OpenURL opens a new browser window pointing to url.

Example

const url = "http://golang.org/"
_ = OpenURL(url)