user

package

v0.1.0 Latest Latest Go to latest Published: Jun 16, 2021 License: Apache-2.0 Imports: 9 Imported by: 0

Details

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

Repository

github.com/10gen/realm-cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func HomeDir() (string, error)
type Credentials
- func (creds Credentials) RedactedPrivateAPIKey() string
type Flags
type Profile
- func NewDefaultProfile() (*Profile, error)
- func NewProfile(name string) (*Profile, error)
type Session

Constants ¶

View Source

const (
	// DefaultProfile is the default profile name
	DefaultProfile = "default"

	// HostingAssetCacheDir is the hosting asset cache dir
	HostingAssetCacheDir = ".asset-cache"
)

View Source

const (
	FlagProfile      = "profile"
	FlagProfileUsage = "specify the profile name to use"

	FlagAtlasBaseURL      = "atlas-url"
	FlagAtlasBaseURLUsage = "specify the base Atlas server URL"

	FlagRealmBaseURL      = "realm-url"
	FlagRealmBaseURLUsage = "specify the base Realm server URL"
)

set of supported CLI user profile flags

Variables ¶

This section is empty.

Functions ¶

func HomeDir ¶

func HomeDir() (string, error)

HomeDir returns the CLI home directory

Types ¶

type Credentials ¶

type Credentials struct {
	PublicAPIKey  string
	PrivateAPIKey string
}

Credentials are the user credentials

func (Credentials) RedactedPrivateAPIKey ¶

func (creds Credentials) RedactedPrivateAPIKey() string

RedactedPrivateAPIKey returns the user's private API key with sensitive information redacted

type Flags ¶

type Flags struct {
	AtlasBaseURL  string
	RealmBaseURL  string
	TelemetryMode telemetry.Mode
}

Flags are the CLI profile flags

type Profile ¶

type Profile struct {
	Flags
	Name             string
	WorkingDirectory string
	// contains filtered or unexported fields
}

Profile is the CLI profile

func NewDefaultProfile ¶

func NewDefaultProfile() (*Profile, error)

NewDefaultProfile creates a new default CLI profile

func NewProfile ¶

func NewProfile(name string) (*Profile, error)

NewProfile creates a new CLI profile

func (Profile) AtlasBaseURL ¶

func (p Profile) AtlasBaseURL() string

AtlasBaseURL gets the CLI profile Atlas base url

func (Profile) Clear ¶

func (p Profile) Clear(name string)

Clear clears the specified CLI profile property

func (Profile) ClearSession ¶

func (p Profile) ClearSession()

ClearSession clears the CLI profile session

func (Profile) Credentials ¶

func (p Profile) Credentials() Credentials

Credentials gets the CLI profile credentials

func (Profile) Dir ¶

func (p Profile) Dir() string

Dir returns the CLI profile directory

func (Profile) GetString ¶

func (p Profile) GetString(name string) string

GetString gets the specified CLI profile property

func (Profile) HostingAssetCachePath ¶

func (p Profile) HostingAssetCachePath() string

HostingAssetCachePath returns the CLI profile's hosting asset cache file path

func (Profile) LastVersionCheck ¶

func (p Profile) LastVersionCheck() time.Time

LastVersionCheck gets the CLI profile last version check

func (Profile) Load ¶

func (p Profile) Load() error

Load loads the CLI profile

func (Profile) Path ¶

func (p Profile) Path() string

Path returns the CLI profile filepath

func (Profile) RealmBaseURL ¶

func (p Profile) RealmBaseURL() string

RealmBaseURL gets the CLI profile Realm base url

func (*Profile) ResolveFlags ¶

func (p *Profile) ResolveFlags() error

ResolveFlags resolves the user profile flags

func (*Profile) Save ¶

func (p *Profile) Save() error

Save saves the CLI profile

func (Profile) Session ¶

func (p Profile) Session() Session

Session gets the CLI profile session

func (Profile) SetAtlasBaseURL ¶

func (p Profile) SetAtlasBaseURL(realmBaseURL string)

SetAtlasBaseURL sets the CLI profile Atlas base url

func (Profile) SetCredentials ¶

func (p Profile) SetCredentials(creds Credentials)

SetCredentials sets the CLI profile credentials

func (Profile) SetLastVersionCheck ¶

func (p Profile) SetLastVersionCheck(t time.Time)

SetLastVersionCheck sets the CLI profile last version check

func (Profile) SetRealmBaseURL ¶

func (p Profile) SetRealmBaseURL(realmBaseURL string)

SetRealmBaseURL sets the CLI profile Realm base url

func (Profile) SetSession ¶

func (p Profile) SetSession(session Session)

SetSession sets the CLI profile session

func (Profile) SetString ¶

func (p Profile) SetString(name, value string)

SetString sets the specified CLI profile property

func (Profile) TelemetryMode ¶

func (p Profile) TelemetryMode() telemetry.Mode

TelemetryMode gets the CLI profile telemetry mode

type Session ¶

type Session struct {
	AccessToken  string
	RefreshToken string
}

Session is the CLI profile session

Source Files ¶

View all Source files

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