cmd

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 14, 2026 License: MIT Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source
const (
	BackendAPI  = "api"
	BackendDB   = "db"
	BackendAuto = "auto"
)

Backend mode constants define how commands fetch data.

BackendAPI: Commands fetch data exclusively from the Beeper Desktop API. If the API is unavailable, commands fail with an error.

BackendDB: Commands fetch data exclusively from the local SQLite database. This mode works offline but data may be stale (last synced when Beeper Desktop was running). Some features are not available in DB mode (pagination, muted/pinned filters, etc.).

BackendAuto (default): Commands try the API first, then automatically fall back to the local database if:

  • The API client cannot be created (network issues, API unavailable)
  • The API call returns an error
  • The API returns empty results

Fallback only occurs when the query can be satisfied by the DB. Commands with API-only features (pagination cursor, direction, inbox filter, etc.) disable fallback automatically.

When fallback occurs, a message is printed to stderr indicating the reason and that DB data is being used. If WarnStale is enabled on the FallbackOptions, an additional warning notes that data may be stale.

Variables

View Source
var (
	Version   = "dev"
	Commit    = "unknown"
	BuildDate = "unknown"
)

These are set via ldflags during build

Functions

func Execute

func Execute(args []string) error

func NewRootCmd

func NewRootCmd() *cobra.Command

func OutputList added in v0.1.7

func OutputList[T any](app *App, ctx context.Context, items []T, emptyMessage string, textFn func(io.Writer, []T)) error

func WithApp added in v0.1.7

func WithApp(ctx context.Context, app *App) context.Context

Types

type App added in v0.1.7

type App struct {
	Config Config
	In     io.Reader
	Out    io.Writer
	Err    io.Writer
}

func AppFromContext added in v0.1.7

func AppFromContext(ctx context.Context) *App

func NewApp added in v0.1.7

func NewApp(cmd *cobra.Command, flags *rootFlags) *App

func (*App) AccountParams added in v0.1.7

func (a *App) AccountParams() url.Values

func (*App) AddAccountIDs added in v0.1.7

func (a *App) AddAccountIDs(params url.Values)

func (*App) Backend added in v0.2.0

func (a *App) Backend() string

func (*App) BaseURL added in v0.1.7

func (a *App) BaseURL() string

func (*App) Client added in v0.1.7

func (a *App) Client(ctx context.Context) (*api.Client, error)

func (*App) ColorEnabled added in v0.1.7

func (a *App) ColorEnabled(ctx context.Context) bool

func (*App) Confirm added in v0.1.7

func (a *App) Confirm(prompt string) (bool, error)

func (*App) IsTextOutput added in v0.1.7

func (a *App) IsTextOutput(ctx context.Context) bool

func (*App) Output added in v0.1.7

func (a *App) Output(ctx context.Context, data any, textFn func(io.Writer)) error

func (*App) OutputEvent added in v0.1.7

func (a *App) OutputEvent(ctx context.Context, data any, textFn func(io.Writer)) error

func (*App) OutputFormat added in v0.1.7

func (a *App) OutputFormat(ctx context.Context) string

func (*App) OutputTextf added in v0.1.7

func (a *App) OutputTextf(ctx context.Context, data any, format string, args ...any) error

func (*App) ProgressWriter added in v0.1.7

func (a *App) ProgressWriter(ctx context.Context) io.Writer

ProgressWriter returns stderr when JSON output is requested to keep stdout clean.

func (*App) ResolveChatByName added in v0.1.7

func (a *App) ResolveChatByName(ctx context.Context, client *api.Client, name string, opts cli.ChatResolveOptions) (string, error)

func (*App) ResolveChatIDFromArgOrFlag added in v0.1.7

func (a *App) ResolveChatIDFromArgOrFlag(ctx context.Context, client *api.Client, args []string, name, label string, opts cli.ChatResolveOptions) (string, error)

func (*App) ResolveChatIDFromFlags added in v0.1.7

func (a *App) ResolveChatIDFromFlags(ctx context.Context, client *api.Client, name, chatID, nameFlag, idFlag string, opts cli.ChatResolveOptions) (string, error)

func (*App) Table added in v0.1.7

func (a *App) Table(ctx context.Context, w io.Writer, headers []string) *outfmt.TableWriter

type Config added in v0.1.7

type Config struct {
	Account string
	Output  string
	Query   string
	Format  string
	Color   string
	Debug   bool
	BaseURL string
	Profile string
	Source  string
	DBPath  string
}

type FallbackEvent added in v0.2.0

type FallbackEvent struct {
	Reason    string // "api_error", "api_empty", "api_unavailable"
	Entity    string // "messages", "chats", etc.
	Timestamp time.Time
	Error     error // original error if any
}

FallbackEvent contains structured information about a fallback occurrence.

type FallbackOptions added in v0.2.0

type FallbackOptions[T any] struct {
	// Backend is the selected backend mode (api, db, auto)
	Backend string
	// FallbackAllowed indicates if fallback is permitted for this operation
	FallbackAllowed bool
	// ProgressWriter receives fallback status messages
	ProgressWriter io.Writer
	// PreAPIError is an error that occurred before API call (e.g., client creation failed)
	// If set and fallback is allowed, DB fallback is attempted without calling APICall
	PreAPIError error
	// APICall executes the API operation
	APICall func() (T, error)
	// DBCall executes the DB operation
	DBCall func(store *db.Store) (T, error)
	// IsEmpty checks if the result should trigger fallback
	IsEmpty func(T) bool
	// OpenStore opens a DB connection
	OpenStore func() (*db.Store, error)
	// EntityName is used in progress messages (e.g., "messages", "chats")
	EntityName string
	// OnFallback is called when fallback is triggered (for metrics/logging)
	OnFallback func(FallbackEvent)
	// WarnStale adds a warning that DB data may be stale when fallback is used
	WarnStale bool
}

FallbackOptions configures the withFallback behavior.

type FallbackResult added in v0.2.0

type FallbackResult[T any] struct {
	Data         T
	UsedFallback bool
	FallbackMsg  string
}

FallbackResult wraps a result with metadata about whether fallback was used.

func (FallbackResult[T]) IsEmpty added in v0.2.0

func (r FallbackResult[T]) IsEmpty() bool

IsEmpty returns true if the underlying data is empty. Works with slices by checking length via reflection.

type InboxItem added in v0.1.6

type InboxItem struct {
	ChatID    string    `json:"chatID"`
	ChatTitle string    `json:"chatTitle"`
	Network   string    `json:"network"`
	ChatType  string    `json:"chatType"`
	Message   string    `json:"message"`
	Sender    string    `json:"sender"`
	Timestamp time.Time `json:"timestamp"`
}

InboxItem represents an unread message with chat context

Jump to

Keyboard shortcuts

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