open

README

go-open

Package open implements a cross-platform supported opens stuff like websites, files, directory or executables.

Documentation

Overview

Package open implements a cross-platform supported opens stuff like websites, files, directory or executables.

Index

• func Command(ctx context.Context, input string, opts ...Option) (*exec.Cmd, error)
• func Run(input string, opts ...Option) error
• func RunContext(ctx context.Context, input string, opts ...Option) error
• func Start(input string, opts ...Option) (func() error, error)
• func StartContext(ctx context.Context, input string, opts ...Option) (func() error, error)
• type Option
  • func WithApplication(app string) Option
  • func WithArgs(args []string) Option
  • func WithDir(dir string) Option
  • func WithEnv(env []string) Option
  • func WithWait() Option

Functions

func Command

func Command(ctx context.Context, input string, opts ...Option) (*exec.Cmd, error)

Command returns the cross-platform supported exec.Command.

func Run

func Run(input string, opts ...Option) error

Run opens the URI, files, directory or executables using the GOOS default application. Wait for the open command to complete.

func RunContext

func RunContext(ctx context.Context, input string, opts ...Option) error

RunContext opens the URI, files, directory or executables using the GOOS default application with context support. Wait for the open command to complete.

func Start

func Start(input string, opts ...Option) (func() error, error)

Start opens the URI, files, directory or executables using the GOOS default application. Don't wait for the open command to complete.

func StartContext

func StartContext(ctx context.Context, input string, opts ...Option) (func() error, error)

StartContext opens the URI, files, directory or executables using the GOOS default application with context support. Don't wait for the open command to complete.

Types

type Option

type Option func(*options)

Option represents a functional pattern option type for options.

func WithApplication

func WithApplication(app string) Option

WithApplication sets the open with specific application to open command.

func WithArgs

func WithArgs(args []string) Option

WithArgs sets the any arguments to open command.

func WithDir

func WithDir(dir string) Option

WithDir sets the directory to open command.

func WithEnv

func WithEnv(env []string) Option

WithEnv sets the environment variables to open command.

func WithWait

func WithWait() Option

WithWait wait for the open command to complete.