client

package

v0.13.3 Latest Latest Go to latest Published: Aug 6, 2025 License: MIT Imports: 14 Imported by: 0

Details

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

Repository

github.com/mdouchement/standardfile

Links

Open Source Insights

Documentation ¶

Index ¶

func Backup() error
func Login() error
func Logout() error
func Note() error
func Refresh(client libsf.Client, cfg *Config) error
func Remove() error
func Save(cfg Config) error
func Unseal(filename string) error
type Config
- func Load() (Config, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Backup ¶

func Backup() error

Backup fetchs all the items and store it in the current directory.

func Login() error

Login connects to a StandardFile server.

func Logout ¶ added in v0.6.0

func Logout() error

Logout disconnects from a StandardFile server.

func Note ¶ added in v0.3.0

func Note() error

Note runs the text-based StandardNotes application.

func Refresh ¶ added in v0.6.0

func Refresh(client libsf.Client, cfg *Config) error

Refresh refreshes the session if needed.

func Remove ¶ added in v0.6.0

func Remove() error

Remove removes the credential files from the current directory.

func Save ¶

func Save(cfg Config) error

Save stores the configuration in the current folder according to `credentialsfile` const.

func Unseal ¶

func Unseal(filename string) error

Unseal decrypt your backuped notes.

Types ¶

type Config ¶

type Config struct {
	Endpoint    string         `json:"endpoint"`
	Email       string         `json:"email"`
	BearerToken string         `json:"bearer_token"` // JWT used before 20200115
	Session     libsf.Session  `json:"session"`      // Since 20200115
	KeyChain    libsf.KeyChain `json:"keychain"`
}

A Config holds client's configuration.

func Load ¶

func Load() (Config, error)

Load gets the configuration from the current folder according to `credentialsfile` const.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
tui

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