client

package

v0.2.4 Latest Latest Go to latest Published: Feb 14, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var ErrNoAuthToken = errors.New("No access token available. Please login with 'flyctl auth login'")

func NewClient(token string) *api.Client

deprecated

func NewContext(ctx context.Context, c *Client) context.Context

NewContext derives a Context that carries c from ctx.

type Client struct {
	IO *iostreams.IOStreams // TODO: remove
	// contains filtered or unexported fields
}

func FromContext(ctx context.Context) *Client

FromContext returns the Client ctx carries. It panics in case ctx carries no Client.

func FromToken(token string) *Client

deprecated

func FromTokens(toks *tokens.Tokens) *Client

func NewClientWithOptions(opts *NewClientOpts) *Client

non-flyctl libraries use this when needing to specify logger, client name, and client version

func (c *Client) API() *api.Client

func (c *Client) Authenticated() bool

type NewClientOpts struct {
	Token         string
	ClientName    string
	ClientVersion string
	Logger        api.Logger
}