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) Capture(ctx context.Context, content string) (app.CaptureResult, error)
- func (client *LocalClient) CreateBookmark(ctx context.Context, url domain.URL, tags domain.Tags) (app.CreateBookmarkResult, error)
- func (client *LocalClient) CreateJournal(ctx context.Context, tags domain.Tags) (app.CreateJournalResult, error)
- func (client *LocalClient) CreatePage(ctx context.Context, title domain.Title, area domain.Area, tags domain.Tags) (app.CreatePageResult, error)
- func (client *LocalClient) CreatePerson(ctx context.Context, name domain.Title, groups domain.Groups, tags domain.Tags) (app.CreatePersonResult, error)
- func (client *LocalClient) DeleteNote(ctx context.Context, id uuid.UUID) error
- func (client *LocalClient) FindJournal(ctx context.Context, date domain.Date) (uuid.UUID, bool, error)
- func (client *LocalClient) ListNotes(ctx context.Context) ([]app.ListedNote, error)
- func (client *LocalClient) OpenNote(ctx context.Context, id uuid.UUID) ([]byte, error)
- func (client *LocalClient) RebuildIndex(ctx context.Context) (int, error)
- func (client *LocalClient) UpdateNote(ctx context.Context, id uuid.UUID, original, source []byte) (app.UpdateNoteResult, 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 {
CreateBookmark(context.Context, domain.URL, domain.Tags) (app.CreateBookmarkResult, error)
Capture(context.Context, string) (app.CaptureResult, error)
CreateJournal(context.Context, domain.Tags) (app.CreateJournalResult, error)
CreatePerson(context.Context, domain.Title, domain.Groups, domain.Tags) (app.CreatePersonResult, error)
CreatePage(context.Context, domain.Title, domain.Area, domain.Tags) (app.CreatePageResult, error)
RebuildIndex(context.Context) (int, error)
ListNotes(context.Context) ([]app.ListedNote, error)
FindJournal(context.Context, domain.Date) (uuid.UUID, bool, error)
OpenNote(context.Context, uuid.UUID) ([]byte, error)
UpdateNote(context.Context, uuid.UUID, []byte, []byte) (app.UpdateNoteResult, error)
DeleteNote(context.Context, uuid.UUID) 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) Capture ¶
func (client *LocalClient) Capture(ctx context.Context, content string) (app.CaptureResult, error)
func (*LocalClient) CreateBookmark ¶
func (client *LocalClient) CreateBookmark(ctx context.Context, url domain.URL, tags domain.Tags) (app.CreateBookmarkResult, error)
func (*LocalClient) CreateJournal ¶
func (client *LocalClient) CreateJournal(ctx context.Context, tags domain.Tags) (app.CreateJournalResult, error)
func (*LocalClient) CreatePage ¶
func (*LocalClient) CreatePerson ¶
func (*LocalClient) DeleteNote ¶
func (*LocalClient) FindJournal ¶
func (*LocalClient) ListNotes ¶
func (client *LocalClient) ListNotes(ctx context.Context) ([]app.ListedNote, error)
func (*LocalClient) RebuildIndex ¶
func (client *LocalClient) RebuildIndex(ctx context.Context) (int, error)
func (*LocalClient) UpdateNote ¶
func (client *LocalClient) UpdateNote(ctx context.Context, id uuid.UUID, original, source []byte) (app.UpdateNoteResult, error)
Source Files
Click to show internal directories.
Click to hide internal directories.