Versions in this module Expand all Collapse all v0 v0.92.1 Jun 6, 2026 v0.92.0 Jun 6, 2026 Changes in this version + func IsNotFound(err error) bool + func IsUnauthorized(err error) bool + type APIError struct + Message string + RetCode string + StatusCode int + func (e *APIError) Error() string + type AppHealthStatus struct + Health string + Name string + Status string + type ArchiveResult struct + Archived bool + type AttachTagsResult struct + Attached []string + type BookmarkClient struct + func (b *BookmarkClient) Archive(ctx context.Context, id string) (*ArchiveResult, error) + func (b *BookmarkClient) AttachTags(ctx context.Context, id string, tags []string) (*AttachTagsResult, error) + func (b *BookmarkClient) CheckUrl(ctx context.Context, url string) (*CheckUrlResult, error) + func (b *BookmarkClient) Create(ctx context.Context, url string) (*karakeep.Bookmark, error) + func (b *BookmarkClient) DetachTags(ctx context.Context, id string, tags []string) (*DetachTagsResult, error) + func (b *BookmarkClient) Get(ctx context.Context, id string) (*karakeep.Bookmark, error) + func (b *BookmarkClient) List(ctx context.Context, query *ListBookmarksQuery) (*karakeep.BookmarksResponse, error) + func (b *BookmarkClient) Search(ctx context.Context, query *SearchBookmarksQuery) (*karakeep.BookmarksResponse, error) + type BuildInfo struct + GoVersion string + MainModule string + MainVersion string + Settings types.KV + type CapabilityHealth struct + App string + Backend string + Capability string + Description string + Status string + type CheckUrlResult struct + BookmarkId *string + type Client struct + Bookmark *BookmarkClient + Dev *DevClient + Forge *ForgeClient + Github *GithubClient + Hub *HubClient + Kanban *KanbanClient + Memo *MemoClient + Pipeline *PipelineClient + Reader *ReaderClient + Search *SearchClient + Server *ServerClient + User *UserClient + Workflow *WorkflowClient + func NewClient(serverURL, token string) *Client + func (c *Client) Delete(ctx context.Context, path string, body, result any) error + func (c *Client) Get(ctx context.Context, path string, result any) error + func (c *Client) Patch(ctx context.Context, path string, body, result any) error + func (c *Client) Post(ctx context.Context, path string, body, result any) error + func (c *Client) Put(ctx context.Context, path string, body, result any) error + func (c *Client) RawRequest() *resty.Request + func (c *Client) SetDebug(debug bool) + func (c *Client) SetTimeout(timeout time.Duration) + type CreateFeedRequest struct + CategoryID int64 + FeedURL string + type CreateFeedResult struct + ID int64 + type CreateMemoRequest struct + Content string + Visibility string + type DetachTagsResult struct + Detached []string + type DevClient struct + func (d *DevClient) Example(ctx context.Context) (*ExampleData, error) + type ExampleData struct + CPU string + Disk string + Mem string + Title string + type FileContentQuery struct + LineCount int + LineStart int + type ForgeClient struct + func (f *ForgeClient) GetCommitDiff(ctx context.Context, owner, repo, commitID string) (*ability.ForgeCommitDiff, error) + func (f *ForgeClient) GetFileContent(ctx context.Context, owner, repo, commitID, filePath string, ...) (string, error) + func (f *ForgeClient) GetIssue(ctx context.Context, owner, repo string, index int64) (*ability.ForgeIssue, error) + func (f *ForgeClient) GetRepo(ctx context.Context, owner, repo string) (*ability.ForgeRepo, error) + func (f *ForgeClient) GetUser(ctx context.Context) (*ability.ForgeUser, error) + func (f *ForgeClient) ListIssues(ctx context.Context, owner string, query *ListIssuesQuery) ([]*ability.ForgeIssue, error) + type GC struct + LastGC string + NumGC uint32 + PauseTotalNs uint64 + type GetFeedEntriesQuery struct + Direction string + Limit int + Offset int + Order string + Starred bool + Status string + type GetSubtaskTimeSpentResult struct + Result float64 + type GithubClient struct + func (g *GithubClient) GetCommitDiff(ctx context.Context, owner, repo, commitID string) (*ability.ForgeCommitDiff, error) + func (g *GithubClient) GetFileContent(ctx context.Context, owner, repo, commitID, filePath string, ...) (string, error) + func (g *GithubClient) GetIssue(ctx context.Context, owner, repo string, number int64) (*ability.ForgeIssue, error) + func (g *GithubClient) GetRepo(ctx context.Context, owner, repo string) (*ability.ForgeRepo, error) + func (g *GithubClient) GetUser(ctx context.Context) (*ability.ForgeUser, error) + func (g *GithubClient) GetUserByLogin(ctx context.Context, login string) (*ability.ForgeUser, error) + func (g *GithubClient) ListIssues(ctx context.Context, owner string, query *ListIssuesQuery) ([]*ability.ForgeIssue, error) + func (g *GithubClient) ListNotifications(ctx context.Context, query *ListNotificationsQuery) ([]*ability.Notification, error) + func (g *GithubClient) ListReleases(ctx context.Context, owner, repo string, query *ListNotificationsQuery) ([]*ability.Release, error) + type HasSubtaskTimerResult struct + Result bool + type HubApp struct + Health string + Labels map[string]any + Name string + Path string + Status string + type HubAppStatus struct + Logs []string + Name string + Status string + type HubCapability struct + App string + Backend string + Description string + Healthy bool + Type string + type HubClient struct + func (h *HubClient) GetApp(ctx context.Context, name string) (*HubApp, error) + func (h *HubClient) GetAppLogs(ctx context.Context, name string, tail int) (*HubAppStatus, error) + func (h *HubClient) GetAppStatus(ctx context.Context, name string) (*HubAppStatus, error) + func (h *HubClient) GetCapability(ctx context.Context, capType string) (*HubCapability, error) + func (h *HubClient) GetHealth(ctx context.Context) (*HubHealth, error) + func (h *HubClient) ListApps(ctx context.Context) ([]HubApp, error) + func (h *HubClient) ListCapabilities(ctx context.Context) ([]HubCapability, error) + func (h *HubClient) RestartApp(ctx context.Context, name string) (map[string]any, error) + func (h *HubClient) StartApp(ctx context.Context, name string) (map[string]any, error) + func (h *HubClient) StopApp(ctx context.Context, name string) (map[string]any, error) + type HubHealth struct + AppStatuses []AppHealthStatus + Details []CapabilityHealth + Status string + Timestamp string + type KanbanClient struct + func (k *KanbanClient) Close(ctx context.Context, id int) (*KanbanUpdateResult, error) + func (k *KanbanClient) Create(ctx context.Context, req KanbanCreateRequest) (*KanbanCreateResult, error) + func (k *KanbanClient) CreateSubtask(ctx context.Context, taskID int, req KanbanCreateSubtaskRequest) (*KanbanCreateSubtaskResult, error) + func (k *KanbanClient) CreateTag(ctx context.Context, req KanbanCreateTagRequest) (*KanbanCreateTagResult, error) + func (k *KanbanClient) Get(ctx context.Context, id int) (*kanboard.Task, error) + func (k *KanbanClient) GetMetadata(ctx context.Context, taskID int) ([]kanboard.TaskMetadata, error) + func (k *KanbanClient) GetMetadataByName(ctx context.Context, taskID int, name string) (string, error) + func (k *KanbanClient) GetSubtask(ctx context.Context, taskID, subtaskID int) (*kanboard.Subtask, error) + func (k *KanbanClient) GetSubtaskTimeSpent(ctx context.Context, taskID, subtaskID, userID int) (*GetSubtaskTimeSpentResult, error) + func (k *KanbanClient) GetTaskTags(ctx context.Context, taskID int) (map[string]string, error) + func (k *KanbanClient) HasSubtaskTimer(ctx context.Context, taskID, subtaskID, userID int) (*HasSubtaskTimerResult, error) + func (k *KanbanClient) List(ctx context.Context, projectID int, status kanboard.StatusId) ([]kanboard.Task, error) + func (k *KanbanClient) ListAll(ctx context.Context, projectID int) ([]kanboard.Task, error) + func (k *KanbanClient) ListColumns(ctx context.Context, projectID int) ([]KanbanColumn, error) + func (k *KanbanClient) ListSubtasks(ctx context.Context, taskID int) ([]kanboard.Subtask, error) + func (k *KanbanClient) ListTags(ctx context.Context) ([]KanbanTag, error) + func (k *KanbanClient) ListTagsByProject(ctx context.Context, projectID int) ([]KanbanTag, error) + func (k *KanbanClient) Move(ctx context.Context, id int, req KanbanMoveRequest) (*KanbanMoveResult, error) + func (k *KanbanClient) RemoveMetadata(ctx context.Context, taskID int, name string) (*KanbanRemoveMetadataResult, error) + func (k *KanbanClient) RemoveSubtask(ctx context.Context, taskID, subtaskID int) (*KanbanRemoveSubtaskResult, error) + func (k *KanbanClient) RemoveTag(ctx context.Context, id int) (*KanbanRemoveTagResult, error) + func (k *KanbanClient) SaveMetadata(ctx context.Context, taskID int, values kanboard.TaskMetadata) (*KanbanSaveMetadataResult, error) + func (k *KanbanClient) Search(ctx context.Context, projectID int, query string) ([]kanboard.Task, error) + func (k *KanbanClient) SetSubtaskEndTime(ctx context.Context, taskID, subtaskID, userID int) (*SetSubtaskEndTimeResult, error) + func (k *KanbanClient) SetSubtaskStartTime(ctx context.Context, taskID, subtaskID, userID int) (*SetSubtaskStartTimeResult, error) + func (k *KanbanClient) SetTaskTags(ctx context.Context, taskID int, req KanbanSetTaskTagsRequest) (*KanbanSetTaskTagsResult, error) + func (k *KanbanClient) Update(ctx context.Context, id int, req KanbanUpdateRequest) (*KanbanUpdateResult, error) + func (k *KanbanClient) UpdateSubtask(ctx context.Context, taskID, subtaskID int, req KanbanUpdateSubtaskRequest) (*KanbanUpdateSubtaskResult, error) + func (k *KanbanClient) UpdateTag(ctx context.Context, id int, req KanbanUpdateTagRequest) (*KanbanUpdateTagResult, error) + type KanbanColumn struct + ID int + Title string + type KanbanCreateRequest struct + ColumnID int + Description string + ProjectID int + Title string + type KanbanCreateResult struct + ID int64 + type KanbanCreateSubtaskRequest struct + Status int + TimeEstimated int + TimeSpent int + Title string + UserID int + type KanbanCreateSubtaskResult struct + ID int64 + type KanbanCreateTagRequest struct + ColorID string + Name string + ProjectID int + type KanbanCreateTagResult struct + ID int64 + type KanbanGetMetadataByNameResult struct + Value string + type KanbanGetMetadataResult struct + Metadata []kanboard.TaskMetadata + type KanbanGetTaskTagsResult struct + Tags map[string]string + type KanbanMoveRequest struct + ColumnID int + Position int + ProjectID int + SwimlaneID int + type KanbanMoveResult struct + Success bool + type KanbanRemoveMetadataResult struct + Success bool + type KanbanRemoveSubtaskResult struct + Success bool + type KanbanRemoveTagResult struct + Success bool + type KanbanSaveMetadataRequest struct + Values kanboard.TaskMetadata + type KanbanSaveMetadataResult struct + Success bool + type KanbanSearchResult struct + Tasks []kanboard.Task + type KanbanSetTaskTagsRequest struct + ProjectID int + Tags []string + type KanbanSetTaskTagsResult struct + Success bool + type KanbanTag struct + ID string + Name string + ProjectID string + type KanbanUpdateRequest struct + Description string + Title string + type KanbanUpdateResult struct + Success bool + type KanbanUpdateSubtaskRequest struct + Status int + TimeEstimated int + TimeSpent int + Title string + UserID int + type KanbanUpdateSubtaskResult struct + Success bool + type KanbanUpdateTagRequest struct + ColorID string + Name string + type KanbanUpdateTagResult struct + Success bool + type ListBookmarksQuery struct + Archived bool + Cursor string + Favourited bool + Limit int + type ListEntriesQuery struct + CategoryID int64 + Direction string + FeedID int64 + Limit int + Offset int + Order string + Starred bool + Status string + type ListFeedsQuery struct + type ListIssuesQuery struct + Cursor string + Limit int + State string + type ListMemosQuery struct + Cursor string + Limit int + type ListNotificationsQuery struct + Cursor string + Limit int + type MemoClient struct + func (m *MemoClient) Create(ctx context.Context, content, visibility string) (*ability.Memo, error) + func (m *MemoClient) Delete(ctx context.Context, name string) error + func (m *MemoClient) Get(ctx context.Context, name string) (*ability.Memo, error) + func (m *MemoClient) Health(ctx context.Context) (bool, error) + func (m *MemoClient) List(ctx context.Context, query *ListMemosQuery) (*MemoListResult, error) + func (m *MemoClient) Update(ctx context.Context, name string, req *UpdateMemoRequest) (*ability.Memo, error) + type MemoHealthResult struct + Healthy bool + type MemoItemResult struct + Item ability.Memo + type MemoListResult struct + Items []*ability.Memo + Page MemoPage + type MemoPage struct + HasMore bool + Limit int + NextCursor string + type Memory struct + RSSBytes int64 + RSSMB float64 + SwapBytes int64 + VMSBytes int64 + VMSMB float64 + type MetricsResult struct + BookmarkTotalStats int64 + BotTotalStats int64 + DockerContainerTotalStats int64 + GiteaIssueTotalStats int64 + KanbanTaskTotalStats int64 + MonitorDownTotalStats int64 + MonitorUpTotalStats int64 + ReaderUnreadTotalStats int64 + TorrentDownloadTotalStats int64 + type PipelineClient struct + func (p *PipelineClient) List(ctx context.Context) (*PipelineListResult, error) + func (p *PipelineClient) Run(ctx context.Context, name string) (*PipelineRunResult, error) + type PipelineInfo struct + Description string + Enabled bool + Name string + Steps []PipelineInfoStep + Trigger PipelineInfoTrigger + type PipelineInfoStep struct + Capability string + Name string + Operation string + Params map[string]any + type PipelineInfoTrigger struct + Event string + type PipelineListResult struct + Pipelines []PipelineInfo + type PipelineRunResult struct + Message string + type Process struct + CPUPercent float64 + CreateTime string + Memory Memory + Name string + NumThreads int32 + PID int + UptimeSeconds float64 + type ReaderClient struct + func (r *ReaderClient) CreateFeed(ctx context.Context, req *CreateFeedRequest) (*CreateFeedResult, error) + func (r *ReaderClient) GetFeed(ctx context.Context, id int64) (*rssClient.Feed, error) + func (r *ReaderClient) GetFeedEntries(ctx context.Context, feedID int64, query *GetFeedEntriesQuery) (*rssClient.EntryResultSet, error) + func (r *ReaderClient) ListEntries(ctx context.Context, query *ListEntriesQuery) (*rssClient.EntryResultSet, error) + func (r *ReaderClient) ListFeeds(ctx context.Context) (rssClient.Feeds, error) + func (r *ReaderClient) RefreshFeed(ctx context.Context, id int64) (*RefreshFeedResult, error) + func (r *ReaderClient) UpdateEntriesStatus(ctx context.Context, req *UpdateEntriesRequest) (*UpdateEntriesResult, error) + func (r *ReaderClient) UpdateFeed(ctx context.Context, id int64, req *UpdateFeedRequest) (*rssClient.Feed, error) + type RefreshFeedResult struct + Success bool + type Runtime struct + GC GC + GoVersion string + Memory RuntimeMemory + NumCPU int + NumGoroutine int + type RuntimeMemory struct + AllocBytes uint64 + AllocMB float64 + HeapAllocBytes uint64 + HeapSysBytes uint64 + SysBytes uint64 + SysMB float64 + TotalAllocBytes uint64 + type SearchBookmarksQuery struct + Cursor string + IncludeContent bool + Limit int + Q string + SortOrder string + type SearchClient struct + func (s *SearchClient) Autocomplete(ctx context.Context, query, source string) ([]SearchResult, error) + func (s *SearchClient) Search(ctx context.Context, query, source string) ([]SearchResult, error) + type SearchResult struct + Content string + ID string + Source string + Title string + URL string + type ServerClient struct + func (s *ServerClient) Stacktrace(ctx context.Context) (*StacktraceResult, error) + func (s *ServerClient) Upload(ctx context.Context, files map[string]io.Reader, filenames map[string]string) (*UploadResult, error) + func (s *ServerClient) UploadMultipart(ctx context.Context, writer *multipart.Writer, body io.Reader) (*UploadResult, error) + type SetSubtaskEndTimeResult struct + Result bool + type SetSubtaskStartTimeResult struct + Result bool + type StacktraceResult struct + BuildInfo BuildInfo + Process Process + Runtime Runtime + StackTrace string + Timestamp string + type UpdateEntriesRequest struct + EntryIDs []int64 + Status string + type UpdateEntriesResult struct + Success bool + type UpdateFeedRequest struct + AllowSelfSignedCertificates *bool + BlockFilterEntryRules string + BlocklistRules string + Cookie string + Crawler *bool + DisableHTTP2 *bool + Disabled *bool + FeedURL string + FetchViaProxy *bool + HideGlobally *bool + IgnoreEntryUpdates *bool + IgnoreHTTPCache *bool + KeepFilterEntryRules string + KeeplistRules string + Password string + RewriteRules string + ScraperRules string + SiteURL string + Title string + UrlRewriteRules string + UserAgent string + Username string + type UpdateMemoRequest struct + Content string + Pinned *bool + Visibility string + type UploadResult struct + Success bool + URLs []string + type UserClient struct + func (u *UserClient) BookmarkList(ctx context.Context) ([]karakeep.Bookmark, error) + func (u *UserClient) Dashboard(ctx context.Context) (types.KV, error) + func (u *UserClient) KanbanList(ctx context.Context) ([]kanboard.Task, error) + func (u *UserClient) Metrics(ctx context.Context) (*MetricsResult, error) + type WorkflowClient struct + func (w *WorkflowClient) RunFile(ctx context.Context, filePath string) (*WorkflowRunResult, error) + type WorkflowRunResult struct + Message string