webbrowser

README

webbrowser

webbrowser provides a simple API for opening web pages on your default browser.

It's inspired on Python's webbrowser package but lacks some of its features (open new window).

It just opens a webpage, most browsers will open it on a new tab.

Installation

As simple as:

go get -u github.com/toqueteos/webbrowser

It is Go modules compatible!

(go.mod was explicitly added in version v1.2.0)

Usage

package main

import "github.com/toqueteos/webbrowser"

func main() {
    webbrowser.Open("http://golang.org")
}

That's it!

Crossplatform support

The package works on:

• android (verified by 3rd party)
• darwin
• freebsd (verified by 3rd party)
• linux
• netbsd (verified by 3rd party)
• openbsd (verified by 3rd party)
• windows

License

It is licensed under the MIT open source license, please see the LICENSE.md file for more information.

Thanks...

Miki Tebeka wrote a nicer version that wasn't on godoc.org when I did this, check it out!.

Already disliking it?

No problem! There's alternative libraries that may be better to your needs:

• https://github.com/pkg/browser, it does what webbrowser does and more!
• https://github.com/skratchdot/open-golang, it even provides a xdg-open implementation in case you don't have it!

Documentation

Overview

Package webbrowser provides a simple API for opening web pages on your default browser.

Index

• Variables
• func Open(s string) (err error)
• type Browser

Variables

var (
	ErrCantOpenBrowser = errors.New("webbrowser: can't open browser")
	ErrNoCandidates    = errors.New("webbrowser: no browser candidate found for your OS")
)

var Candidates []Browser

Candidates contains a list of registered `Browser`s that will be tried with Open.

Functions

func Open

func Open(s string) (err error)

Open tries to open a URL in your default browser ensuring you have a display set up and not running this from SSH. NOTE: This may cause your program to hang until the browser process is closed in some OSes, see https://github.com/toqueteos/webbrowser/issues/4. SECURITY(windows): Do not use a file:// URLs pointing to an executable, this can execute programs, see https://github.com/toqueteos/webbrowser/issues/10

Types

type Browser

type Browser interface {
	// Command returns a ready to be used Cmd that will open an URL.
	Command(string) (*exec.Cmd, error)
	// Open tries to open a URL in your default browser. NOTE: This may cause
	// your program to hang until the browser process is closed in some OSes,
	// see https://github.com/toqueteos/webbrowser/issues/4.
	Open(string) error
}