auth

package

v1.58.3 Latest Latest Go to latest Published: Aug 25, 2026 License: MPL-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/encoredev/encore

Links

Open Source Insights

Documentation ¶

Index ¶

func DoLogin(flow Flow) (err error)
func DoLoginWithAuthKey() error
func DoLogout()
func LoginWithAuthKey(key string) error
func LoginWithEnvKeyIfNeeded()
func Whoami()
type Flow

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DoLogin ¶

func DoLogin(flow Flow) (err error)

func DoLoginWithAuthKey ¶

func DoLoginWithAuthKey() error

func DoLogout ¶

func DoLogout()

func LoginWithAuthKey ¶ added in v1.58.3

func LoginWithAuthKey(key string) error

LoginWithAuthKey exchanges the given auth key for credentials and persists them.

func LoginWithEnvKeyIfNeeded ¶ added in v1.58.3

func LoginWithEnvKeyIfNeeded()

LoginWithEnvKeyIfNeeded logs in using the ENCORE_AUTH_KEY environment variable when it is set and no user is currently logged in. This gives agents and CI a non-interactive way to authenticate, avoiding the browser-based login flow.

func Whoami ¶

func Whoami()

Types ¶

type Flow ¶ added in v1.21.1

type Flow int

const (
	AutoFlow Flow = iota
	Interactive
	DeviceAuth
)

Source Files ¶

View all Source files

auth.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL