Documentation
¶
Index ¶
- Variables
- func New(configFile *configlib.ConfigFile[appconfig.Settings], newClient ClientFactory) *urfavecli.Command
- func NewSetupCommand(configFile *configlib.ConfigFile[appconfig.Settings]) *urfavecli.Command
- type Client
- type ClientFactory
- type LocalClient
- func (client *LocalClient) CreateBookmark(ctx context.Context, command app.CreateBookmarkCommand) (app.CreateBookmarkResult, error)
- func (client *LocalClient) CreateHabit(ctx context.Context, command app.CreateHabitCommand) (app.CreateHabitResult, error)
- func (client *LocalClient) CreateInbox(ctx context.Context, command app.CreateInboxCommand) (app.CreateInboxResult, error)
- func (client *LocalClient) CreateJournal(ctx context.Context, command app.CreateJournalCommand) (app.CreateJournalResult, error)
- func (client *LocalClient) CreatePage(ctx context.Context, command app.CreatePageCommand) (app.CreatePageResult, error)
- func (client *LocalClient) CreatePerson(ctx context.Context, command app.CreatePersonCommand) (app.CreatePersonResult, error)
- func (client *LocalClient) DeleteNote(ctx context.Context, command app.DeleteNoteCommand) (app.DeleteNoteResult, error)
- func (client *LocalClient) ListNotes(ctx context.Context, query app.ListNotesQuery) (app.ListNotesResult, error)
- func (client *LocalClient) Reindex(ctx context.Context, command app.ReindexCommand) (app.ReindexResult, error)
Constants ¶
This section is empty.
Variables ¶
View Source
var Version string
Version can be set with -ldflags "-X github.com/vekio/overmind/internal/cli.Version=vX.Y.Z".
Functions ¶
func New ¶
func New(configFile *configlib.ConfigFile[appconfig.Settings], newClient ClientFactory) *urfavecli.Command
func NewSetupCommand ¶
NewSetupCommand creates the interactive configuration command.
Types ¶
type Client ¶
type Client interface {
DeleteNote(context.Context, app.DeleteNoteCommand) (app.DeleteNoteResult, error)
Reindex(context.Context, app.ReindexCommand) (app.ReindexResult, error)
ListNotes(context.Context, app.ListNotesQuery) (app.ListNotesResult, error)
CreateHabit(context.Context, app.CreateHabitCommand) (app.CreateHabitResult, error)
CreateBookmark(context.Context, app.CreateBookmarkCommand) (app.CreateBookmarkResult, error)
CreateInbox(context.Context, app.CreateInboxCommand) (app.CreateInboxResult, error)
CreateJournal(context.Context, app.CreateJournalCommand) (app.CreateJournalResult, error)
CreatePerson(context.Context, app.CreatePersonCommand) (app.CreatePersonResult, error)
CreatePage(context.Context, app.CreatePageCommand) (app.CreatePageResult, error)
}
Client provides the note operations used by the CLI.
type ClientFactory ¶
ClientFactory creates the client after command flags have been parsed.
type LocalClient ¶
type LocalClient struct {
// contains filtered or unexported fields
}
LocalClient runs CLI operations against the in-process application.
func NewLocalClient ¶
func NewLocalClient(application *app.Application) *LocalClient
NewLocalClient adapts an application running in this process to the CLI.
func (*LocalClient) CreateBookmark ¶
func (client *LocalClient) CreateBookmark(ctx context.Context, command app.CreateBookmarkCommand) (app.CreateBookmarkResult, error)
func (*LocalClient) CreateHabit ¶ added in v0.3.0
func (client *LocalClient) CreateHabit(ctx context.Context, command app.CreateHabitCommand) (app.CreateHabitResult, error)
CreateHabit forwards raw CLI input to the use case's domain validation.
func (*LocalClient) CreateInbox ¶ added in v0.3.0
func (client *LocalClient) CreateInbox(ctx context.Context, command app.CreateInboxCommand) (app.CreateInboxResult, error)
func (*LocalClient) CreateJournal ¶
func (client *LocalClient) CreateJournal(ctx context.Context, command app.CreateJournalCommand) (app.CreateJournalResult, error)
func (*LocalClient) CreatePage ¶
func (client *LocalClient) CreatePage(ctx context.Context, command app.CreatePageCommand) (app.CreatePageResult, error)
func (*LocalClient) CreatePerson ¶
func (client *LocalClient) CreatePerson(ctx context.Context, command app.CreatePersonCommand) (app.CreatePersonResult, error)
func (*LocalClient) DeleteNote ¶
func (client *LocalClient) DeleteNote(ctx context.Context, command app.DeleteNoteCommand) (app.DeleteNoteResult, error)
func (*LocalClient) ListNotes ¶
func (client *LocalClient) ListNotes(ctx context.Context, query app.ListNotesQuery) (app.ListNotesResult, error)
func (*LocalClient) Reindex ¶ added in v0.3.0
func (client *LocalClient) Reindex(ctx context.Context, command app.ReindexCommand) (app.ReindexResult, error)
Source Files
Click to show internal directories.
Click to hide internal directories.