Version: v0.78.5 Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Nov 6, 2020 License: MIT Imports: 24 Imported by: 0



A lib to help launch or download browser. You can also use it as a standalone lib without Rod.



Package launcher for launching browser utils.

Example (Custom_launch)
package main

import (


func main() {
	// get the browser executable path
	bin, err := launcher.NewBrowser().Get()

	// use the helper to construct args, this line is optional, you can construct the args manually
	args := launcher.New().Headless(false).Env("TZ=Asia/Tokyo").FormatArgs()

	parser := launcher.NewURLParser()

	cmd := exec.Command(bin, args...)
	cmd.Stderr = parser
	err = cmd.Start()





View Source
const DefaultRevision = 809590

DefaultRevision for chrome

View Source
const HeaderName = "Rod-Launcher"

HeaderName for remote launch

View Source
const HostGoogle = ""

HostGoogle to download browser

View Source
const HostTaobao = ""

HostTaobao to download browser


This section is empty.


func MustResolveURL

func MustResolveURL(u string) string

MustResolveURL is similar to FetchURL

func ResolveURL

func ResolveURL(u string) (string, error)

ResolveURL by requesting the u, it will try best to normalize the u. The format of u can be "9222", ":9222", "host:9222", "ws://host:9222", "wss://host:9222", "https://host:9222" "http://host:9222". The return string will look like: "ws://host:9222/devtools/browser/4371405f-84df-4ad6-9e0f-eab81f7521cc"


type Browser

type Browser struct {
	Context context.Context

	// Hosts to download browser, examples:
	Hosts []string

	// Revision of the browser to use
	Revision int

	// Dir default is the filepath.Join(os.TempDir(), "rod")
	Dir string

	// Log to print output
	Logger io.Writer

	ExecSearchMap map[string][]string

	// Lock a tcp port to prevent race downloading. Default is 2968 .
	Lock int

Browser is a helper to download browser smartly

func NewBrowser

func NewBrowser() *Browser

NewBrowser with default values

func (*Browser) Download

func (lc *Browser) Download() error

Download chromium

func (*Browser) ExecPath

func (lc *Browser) ExecPath() string

ExecPath of the chromium executable

func (*Browser) Get

func (lc *Browser) Get() (string, error)

Get is a smart helper to get the browser executable binary. It will first try to find the browser from local disk, if not exists it will try to download the chromium to Dir.

func (*Browser) LookPath

func (lc *Browser) LookPath() (string, bool)

LookPath of the browser executable.

func (*Browser) Open

func (lc *Browser) Open(url string)

Open url via a browser

type Launcher

type Launcher struct {
	Flags map[string][]string `json:"flags"`
	// contains filtered or unexported fields

Launcher is a helper to launch browser binary smartly

func MustNewRemote

func MustNewRemote(remoteURL string) *Launcher

MustNewRemote is similar to NewRemote

func New

func New() *Launcher

New returns the default arguments to start browser. Headless will be enabled by default. Leakless will be enabled by default. UserDataDir will use OS tmp dir by default.

func NewRemote

func NewRemote(remoteURL string) (*Launcher, error)

NewRemote creates a Launcher instance from remote defaults. For more info check the doc of RemoteLauncher.

func NewUserMode

func NewUserMode() *Launcher

NewUserMode is a preset to enable reusing current user data. Useful for automation of personal browser. If you see any error, it may because you can't launch debug port for existing browser, the solution is to completely close the running browser. Unfortunately, there's no API for rod to tell it automatically yet.

func (*Launcher) Append

func (l *Launcher) Append(name string, values ...string) *Launcher

Append values to the flag

func (*Launcher) Bin

func (l *Launcher) Bin(path string) *Launcher

Bin set browser executable file path. If it's empty, launcher will automatically search or download the bin.

func (*Launcher) Cleanup

func (l *Launcher) Cleanup()

Cleanup wait until the Browser exits and remove UserDataDir

func (*Launcher) Client

func (l *Launcher) Client() *cdp.Client

Client for launching browser remotely, such as browser from a docker container.

func (*Launcher) Context

func (l *Launcher) Context(ctx context.Context) *Launcher

Context set the context

func (*Launcher) Delete

func (l *Launcher) Delete(name string) *Launcher

Delete a flag

func (*Launcher) Devtools

func (l *Launcher) Devtools(autoOpenForTabs bool) *Launcher

Devtools switch to auto open devtools for each tab

func (*Launcher) Env

func (l *Launcher) Env(env ...string) *Launcher

Env to launch the browser process. The default value is os.Environ(). Usually you use it to set the timezone env. Such as Env("TZ=America/New_York"). Timezone list:

func (*Launcher) FormatArgs

func (l *Launcher) FormatArgs() []string

FormatArgs returns the formated arg list for cli

func (*Launcher) Get

func (l *Launcher) Get(name string) (string, bool)

Get flag's first value

func (*Launcher) GetFlags

func (l *Launcher) GetFlags(name string) ([]string, bool)

GetFlags from settings

func (*Launcher) Headless

func (l *Launcher) Headless(enable bool) *Launcher

Headless switch. Whether to run browser in headless mode. A mode without visible UI.

func (*Launcher) JSON

func (l *Launcher) JSON() []byte

JSON serialization

func (*Launcher) KeepUserDataDir

func (l *Launcher) KeepUserDataDir() *Launcher

KeepUserDataDir after remote browser is closed. By default user-data-dir will be removed.

func (*Launcher) Kill

func (l *Launcher) Kill()

Kill the browser process

func (*Launcher) Launch

func (l *Launcher) Launch() (string, error)

Launch a standalone temp browser instance and returns the debug url. bin and profileDir are optional, set them to empty to use the default values. If you want to reuse sessions, such as cookies, set the UserDataDir to the same location.

func (*Launcher) Leakless

func (l *Launcher) Leakless(enable bool) *Launcher

Leakless switch. If enabled, the browser will be force killed after the Go process exits. The doc of leakless:

func (*Launcher) Logger

func (l *Launcher) Logger(w io.Writer) *Launcher

Logger to handle stdout and stderr from browser. For example, pipe all browser output to stdout: launcher.New().Logger(os.Stdout)

func (*Launcher) MustLaunch

func (l *Launcher) MustLaunch() string

MustLaunch is similar to Launch

func (*Launcher) PID

func (l *Launcher) PID() int

PID returns the browser process pid

func (*Launcher) ProfileDir

func (l *Launcher) ProfileDir(dir string) *Launcher

ProfileDir is the browser profile the browser will use. When set to empty, the profile 'Default' is used. Related article:

func (*Launcher) Proxy

func (l *Launcher) Proxy(host string) *Launcher

Proxy switch. When disabled leakless will be disabled.

func (*Launcher) RemoteDebuggingPort

func (l *Launcher) RemoteDebuggingPort(port int) *Launcher

RemoteDebuggingPort to launch the browser. Zero for a random port. Zero is the default value. If it's not zero, the launcher will try to connect to it before starting a new browser process. For example, to reuse the same browser process for between 2 runs of a Go program, you can do something like:


Related doc:

func (*Launcher) Set

func (l *Launcher) Set(name string, values ...string) *Launcher

Set a command line argument to launch the browser. People also call it command line flag or switch. List of available flags:

func (*Launcher) UserDataDir

func (l *Launcher) UserDataDir(dir string) *Launcher

UserDataDir is where the browser will look for all of its state, such as cookie and cache. When set to empty, browser will use current OS home dir. Related doc:

func (*Launcher) WorkingDir

func (l *Launcher) WorkingDir(path string) *Launcher

WorkingDir to launch the browser process.

type RemoteLauncher

type RemoteLauncher struct {
	Logger utils.Logger

RemoteLauncher is used to launch browsers via http server on another machine. For example, the work flow looks like:

|     Machine A      |                           Machine B                                  |
 NewRemote("") --> http.ListenAndServe("", NewRemoteLauncher()) --> launch browser

Any http request will return a default Launcher based on remote OS environment. Any websocket request will start a new browser and the request will be proxied to the browser. The websocket header "Rod-Launcher" holds the options to launch browser. If the websocket is closed, the browser will be killed.

func NewRemoteLauncher

func NewRemoteLauncher() *RemoteLauncher

NewRemoteLauncher instance

func (*RemoteLauncher) ServeHTTP

func (p *RemoteLauncher) ServeHTTP(w http.ResponseWriter, r *http.Request)

type URLParser

type URLParser struct {

	URL    chan string
	Buffer string // buffer for the browser stdout
	// contains filtered or unexported fields

URLParser to get control url from stderr

func NewURLParser

func NewURLParser() *URLParser

NewURLParser instance

func (*URLParser) Write

func (r *URLParser) Write(p []byte) (n int, err error)

Write interface


Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL