Documentation
¶
Index ¶
- func Execute(args []string) (err error)
- func VersionString() string
- type ACLsCmd
- type ACLsUpdateCmd
- type AttachmentsCmd
- type AttachmentsCreateCmd
- type AttachmentsListCmd
- type AttachmentsUploadCmd
- type AuditLogsCmd
- type AuditLogsQueryCmd
- type AuthCmd
- type AuthRemoveCmd
- type AuthSetKeyCmd
- type AuthSetTeamCmd
- type AuthSetWorkspaceCmd
- type AuthStatusCmd
- type AuthTokenCmd
- type AuthWhoamiCmd
- type CLI
- type ChatChannelCmd
- type ChatChannelFollowersCmd
- type ChatChannelMembersCmd
- type ChatChannelsCmd
- type ChatCmd
- type ChatCreateChannelCmd
- type ChatCreateDMCmd
- type ChatCreateLocChannelCmd
- type ChatDeleteChannelCmd
- type ChatDeleteMessageCmd
- type ChatMessagesCmd
- type ChatReactCmd
- type ChatReactionsCmd
- type ChatRepliesCmd
- type ChatReplyCmd
- type ChatSendCmd
- type ChatTaggedUsersCmd
- type ChatUnreactCmd
- type ChatUpdateChannelCmd
- type ChatUpdateMessageCmd
- type ChecklistsAddItemCmd
- type ChecklistsCmd
- type ChecklistsCreateCmd
- type ChecklistsDeleteCmd
- type ChecklistsDeleteItemCmd
- type ChecklistsUpdateCmd
- type ChecklistsUpdateItemCmd
- type CommentsAddCmd
- type CommentsAddListCmd
- type CommentsAddViewCmd
- type CommentsCmd
- type CommentsDeleteCmd
- type CommentsListCmd
- type CommentsListCommentsCmd
- type CommentsRepliesCmd
- type CommentsReplyCmd
- type CommentsSubtypesCmd
- type CommentsUpdateCmd
- type CommentsViewCommentsCmd
- type DocsCmd
- type DocsCreateCmd
- type DocsCreatePageCmd
- type DocsEditPageCmd
- type DocsGetCmd
- type DocsPageCmd
- type DocsPageListingCmd
- type DocsPagesCmd
- type DocsSearchCmd
- type ExitError
- type FieldsCmd
- type FieldsListCmd
- type FieldsRemoveCmd
- type FieldsSetCmd
- type FoldersCmd
- type FoldersCreateCmd
- type FoldersDeleteCmd
- type FoldersFromTemplateCmd
- type FoldersGetCmd
- type FoldersUpdateCmd
- type GoalsAddKeyResultCmd
- type GoalsCmd
- type GoalsCreateCmd
- type GoalsDeleteCmd
- type GoalsDeleteKeyResultCmd
- type GoalsGetCmd
- type GoalsListCmd
- type GoalsUpdateCmd
- type GoalsUpdateKeyResultCmd
- type GroupsCmd
- type GroupsCreateCmd
- type GroupsDeleteCmd
- type GroupsListCmd
- type GroupsUpdateCmd
- type GuestsAddToFolderCmd
- type GuestsAddToListCmd
- type GuestsAddToTaskCmd
- type GuestsCmd
- type GuestsGetCmd
- type GuestsInviteCmd
- type GuestsRemoveCmd
- type GuestsRemoveFromFolderCmd
- type GuestsRemoveFromListCmd
- type GuestsRemoveFromTaskCmd
- type GuestsUpdateCmd
- type ListsAddTaskCmd
- type ListsCmd
- type ListsCreateCmd
- type ListsDeleteCmd
- type ListsFromTemplateCmd
- type ListsGetCmd
- type ListsListCmd
- type ListsRemoveTaskCmd
- type ListsUpdateCmd
- type MembersCmd
- type MembersListCmd
- type MembersListMembersCmd
- type MembersTaskMembersCmd
- type RelationshipsAddDepCmd
- type RelationshipsCmd
- type RelationshipsLinkCmd
- type RelationshipsRemoveDepCmd
- type RelationshipsUnlinkCmd
- type RolesCmd
- type RolesListCmd
- type RootFlags
- type SharedCmd
- type SharedListCmd
- type SpacesCmd
- type SpacesCreateCmd
- type SpacesDeleteCmd
- type SpacesGetCmd
- type SpacesListCmd
- type SpacesUpdateCmd
- type TagsAddCmd
- type TagsCmd
- type TagsCreateCmd
- type TagsDeleteCmd
- type TagsListCmd
- type TagsRemoveCmd
- type TagsUpdateCmd
- type TaskTypesCmd
- type TaskTypesListCmd
- type TasksBulkTimeInStatusCmd
- type TasksCmd
- type TasksCreateCmd
- type TasksDeleteCmd
- type TasksFromTemplateCmd
- type TasksGetCmd
- type TasksListCmd
- type TasksMergeCmd
- type TasksMoveCmd
- type TasksSearchCmd
- type TasksTimeInStatusCmd
- type TasksUpdateCmd
- type TemplatesCmd
- type TemplatesListCmd
- type TimeAddTagsCmd
- type TimeCmd
- type TimeCurrentCmd
- type TimeDeleteCmd
- type TimeGetCmd
- type TimeHistoryCmd
- type TimeLegacyCmd
- type TimeLegacyDeleteCmd
- type TimeLegacyListCmd
- type TimeLegacyTrackCmd
- type TimeLegacyUpdateCmd
- type TimeListCmd
- type TimeLogCmd
- type TimeRemoveTagsCmd
- type TimeRenameTagCmd
- type TimeStartCmd
- type TimeStopCmd
- type TimeTagsCmd
- type TimeUpdateCmd
- type UsersCmd
- type UsersGetCmd
- type UsersInviteCmd
- type UsersRemoveCmd
- type UsersUpdateCmd
- type VersionCmd
- type ViewsCmd
- type ViewsCreateCmd
- type ViewsDeleteCmd
- type ViewsGetCmd
- type ViewsListCmd
- type ViewsTasksCmd
- type ViewsUpdateCmd
- type WebhooksCmd
- type WebhooksCreateCmd
- type WebhooksDeleteCmd
- type WebhooksListCmd
- type WebhooksUpdateCmd
- type WorkspacesCmd
- type WorkspacesListCmd
- type WorkspacesPlanCmd
- type WorkspacesSeatsCmd
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func VersionString ¶
func VersionString() string
Types ¶
type ACLsCmd ¶
type ACLsCmd struct {
Update ACLsUpdateCmd `cmd:"" help:"Update access control settings"`
}
type ACLsUpdateCmd ¶
type ACLsUpdateCmd struct {
ObjectType string `name:"type" short:"t" required:"" help:"Object type (space, folder, list)"`
ObjectID string `name:"id" short:"i" required:"" help:"Object ID"`
Private bool `help:"Make object private"`
Public bool `help:"Make object public"`
Sharing string `help:"Sharing mode (open or closed)"`
}
type AttachmentsCmd ¶
type AttachmentsCmd struct {
Upload AttachmentsUploadCmd `cmd:"" help:"Upload a file to a task (v2 API)"`
List AttachmentsListCmd `cmd:"" help:"List attachments for a parent entity (v3 API)"`
Create AttachmentsCreateCmd `cmd:"" help:"Upload a file to a parent entity (v3 API)"`
}
type AttachmentsCreateCmd ¶
type AttachmentsListCmd ¶
type AttachmentsUploadCmd ¶
type AuditLogsCmd ¶
type AuditLogsCmd struct {
Query AuditLogsQueryCmd `cmd:"" help:"Query audit logs"`
}
type AuditLogsQueryCmd ¶
type AuditLogsQueryCmd struct {
StartDate int64 `help:"Start date (Unix timestamp in milliseconds)"`
EndDate int64 `help:"End date (Unix timestamp in milliseconds)"`
EventType string `help:"Filter by event type"`
UserID string `help:"Filter by user ID"`
Limit int `help:"Maximum number of results" default:"100"`
}
type AuthCmd ¶
type AuthCmd struct {
SetKey AuthSetKeyCmd `cmd:"" help:"Set API key (uses --stdin by default)"`
SetTeam AuthSetTeamCmd `cmd:"" help:"Set ClickUp Team ID"`
SetWorkspace AuthSetWorkspaceCmd `cmd:"" help:"Set ClickUp Workspace ID for v3 API"`
Status AuthStatusCmd `cmd:"" help:"Show authentication status"`
Remove AuthRemoveCmd `cmd:"" help:"Remove stored credentials"`
Whoami AuthWhoamiCmd `cmd:"" help:"Get the currently authorized user"`
Token AuthTokenCmd `cmd:"" help:"Exchange OAuth authorization code for access token"`
}
type AuthRemoveCmd ¶
type AuthRemoveCmd struct{}
type AuthSetKeyCmd ¶
type AuthSetTeamCmd ¶
type AuthSetTeamCmd struct {
TeamID string `arg:"" required:"" help:"ClickUp Team ID"`
}
type AuthSetWorkspaceCmd ¶
type AuthSetWorkspaceCmd struct {
WorkspaceID string `arg:"" required:"" help:"ClickUp Workspace ID for v3 API"`
}
type AuthStatusCmd ¶
type AuthStatusCmd struct{}
type AuthTokenCmd ¶
type AuthWhoamiCmd ¶
type AuthWhoamiCmd struct{}
type CLI ¶
type CLI struct {
RootFlags `embed:""`
Version kong.VersionFlag `help:"Print version and exit"`
Auth AuthCmd `cmd:"" help:"Auth and credentials"`
Workspaces WorkspacesCmd `cmd:"" help:"Workspace operations"`
Tasks TasksCmd `cmd:"" help:"Task operations"`
Spaces SpacesCmd `cmd:"" help:"Space operations"`
Folders FoldersCmd `cmd:"" help:"Folder operations"`
Lists ListsCmd `cmd:"" help:"List operations"`
Members MembersCmd `cmd:"" help:"Team member operations"`
Comments CommentsCmd `cmd:"" help:"Comment operations"`
Time TimeCmd `cmd:"" help:"Time tracking"`
Groups GroupsCmd `cmd:"" help:"User group operations"`
Roles RolesCmd `cmd:"" help:"Custom role operations"`
Guests GuestsCmd `cmd:"" help:"Guest operations"`
Templates TemplatesCmd `cmd:"" help:"Task template operations"`
TaskTypes TaskTypesCmd `cmd:"" help:"Custom task type operations"`
TimeLegacy TimeLegacyCmd `cmd:"" help:"Legacy time tracking operations"`
AuditLogs AuditLogsCmd `cmd:"" help:"Audit log operations"`
ACLs ACLsCmd `cmd:"" help:"Access control operations"`
Tags TagsCmd `cmd:"" help:"Tag operations"`
Checklists ChecklistsCmd `cmd:"" help:"Checklist operations"`
Relationships RelationshipsCmd `cmd:"" help:"Task relationship operations"`
Fields FieldsCmd `cmd:"" help:"Custom field operations"`
Views ViewsCmd `cmd:"" help:"View operations"`
Webhooks WebhooksCmd `cmd:"" help:"Webhook operations"`
Goals GoalsCmd `cmd:"" help:"Goal and key result operations"`
Users UsersCmd `cmd:"" help:"User management operations"`
Attachments AttachmentsCmd `cmd:"" help:"File attachment operations"`
Chat ChatCmd `cmd:"" help:"Chat operations (v3 API)"`
Docs DocsCmd `cmd:"" help:"Docs operations (v3 API)"`
VersionCmd VersionCmd `cmd:"" name:"version" help:"Print version"`
}
type ChatChannelCmd ¶
type ChatChannelCmd struct {
ChannelID string `arg:"" help:"Channel ID" required:""`
}
type ChatChannelFollowersCmd ¶
type ChatChannelFollowersCmd struct {
ChannelID string `arg:"" help:"Channel ID" required:""`
}
type ChatChannelMembersCmd ¶
type ChatChannelMembersCmd struct {
ChannelID string `arg:"" help:"Channel ID" required:""`
}
type ChatChannelsCmd ¶
type ChatChannelsCmd struct{}
type ChatCmd ¶
type ChatCmd struct {
Channels ChatChannelsCmd `cmd:"" help:"List all chat channels"`
Channel ChatChannelCmd `cmd:"" help:"Get channel details"`
ChannelFollowers ChatChannelFollowersCmd `cmd:"" help:"Get channel followers"`
ChannelMembers ChatChannelMembersCmd `cmd:"" help:"Get channel members"`
CreateChannel ChatCreateChannelCmd `cmd:"" help:"Create a channel"`
CreateDM ChatCreateDMCmd `cmd:"" help:"Create a direct message channel"`
CreateLocChannel ChatCreateLocChannelCmd `cmd:"" help:"Create a location-based channel"`
UpdateChannel ChatUpdateChannelCmd `cmd:"" help:"Update a channel"`
DeleteChannel ChatDeleteChannelCmd `cmd:"" help:"Delete a channel"`
Messages ChatMessagesCmd `cmd:"" help:"List channel messages"`
Send ChatSendCmd `cmd:"" help:"Send a message"`
UpdateMessage ChatUpdateMessageCmd `cmd:"" help:"Update a message"`
DeleteMessage ChatDeleteMessageCmd `cmd:"" help:"Delete a message"`
Reactions ChatReactionsCmd `cmd:"" help:"List message reactions"`
React ChatReactCmd `cmd:"" help:"Add a reaction"`
Unreact ChatUnreactCmd `cmd:"" help:"Remove a reaction"`
Replies ChatRepliesCmd `cmd:"" help:"List message replies"`
Reply ChatReplyCmd `cmd:"" help:"Reply to a message"`
TaggedUsers ChatTaggedUsersCmd `cmd:"" help:"Get tagged users in a message"`
}
type ChatCreateChannelCmd ¶
type ChatCreateChannelCmd struct {
Name string `name:"name" short:"n" help:"Channel name" required:""`
}
type ChatCreateDMCmd ¶
type ChatCreateDMCmd struct {
Members string `name:"members" short:"m" help:"Comma-separated user IDs" required:""`
}
type ChatCreateLocChannelCmd ¶
type ChatDeleteChannelCmd ¶
type ChatDeleteChannelCmd struct {
ChannelID string `arg:"" help:"Channel ID" required:""`
}
type ChatDeleteMessageCmd ¶
type ChatDeleteMessageCmd struct {
MessageID string `arg:"" help:"Message ID" required:""`
}
type ChatMessagesCmd ¶
type ChatReactCmd ¶
type ChatReactionsCmd ¶
type ChatReactionsCmd struct {
MessageID string `arg:"" help:"Message ID" required:""`
}
type ChatRepliesCmd ¶
type ChatRepliesCmd struct {
MessageID string `arg:"" help:"Message ID" required:""`
}
type ChatReplyCmd ¶
type ChatSendCmd ¶
type ChatTaggedUsersCmd ¶
type ChatTaggedUsersCmd struct {
MessageID string `arg:"" help:"Message ID" required:""`
}
type ChatUnreactCmd ¶
type ChatUpdateChannelCmd ¶
type ChatUpdateMessageCmd ¶
type ChecklistsAddItemCmd ¶
type ChecklistsCmd ¶
type ChecklistsCmd struct {
Create ChecklistsCreateCmd `cmd:"" help:"Create a checklist on a task"`
Update ChecklistsUpdateCmd `cmd:"" help:"Update a checklist"`
Delete ChecklistsDeleteCmd `cmd:"" help:"Delete a checklist"`
AddItem ChecklistsAddItemCmd `cmd:"" help:"Add an item to a checklist"`
UpdateItem ChecklistsUpdateItemCmd `cmd:"" help:"Update a checklist item"`
DeleteItem ChecklistsDeleteItemCmd `cmd:"" help:"Delete a checklist item"`
}
type ChecklistsCreateCmd ¶
type ChecklistsDeleteCmd ¶
type ChecklistsDeleteCmd struct {
ChecklistID string `arg:"" required:"" help:"Checklist ID"`
}
type ChecklistsDeleteItemCmd ¶
type ChecklistsUpdateCmd ¶
type ChecklistsUpdateItemCmd ¶
type ChecklistsUpdateItemCmd struct {
ChecklistID string `arg:"" required:"" help:"Checklist ID"`
ItemID string `arg:"" required:"" help:"Item ID"`
Name string `help:"New item name"`
Resolved *bool `help:"Mark as resolved (true/false)"`
Assignee int `help:"Assignee user ID"`
Parent string `help:"Parent item ID for nesting"`
}
type CommentsAddCmd ¶
type CommentsAddListCmd ¶
type CommentsAddViewCmd ¶
type CommentsCmd ¶
type CommentsCmd struct {
List CommentsListCmd `cmd:"" help:"List comments on a task"`
Add CommentsAddCmd `cmd:"" help:"Add a comment to a task"`
Delete CommentsDeleteCmd `cmd:"" help:"Delete a comment"`
Update CommentsUpdateCmd `cmd:"" help:"Update a comment"`
Replies CommentsRepliesCmd `cmd:"" help:"List threaded replies to a comment"`
Reply CommentsReplyCmd `cmd:"" help:"Create a threaded reply to a comment"`
ListComments CommentsListCommentsCmd `cmd:"" help:"List comments on a list" aliases:"list-comments"`
AddList CommentsAddListCmd `cmd:"" help:"Add a comment to a list" aliases:"add-list"`
ViewComments CommentsViewCommentsCmd `cmd:"" help:"List comments on a view" aliases:"view-comments"`
AddView CommentsAddViewCmd `cmd:"" help:"Add a comment to a view" aliases:"add-view"`
Subtypes CommentsSubtypesCmd `cmd:"" help:"Get post subtype IDs (v3 API)"`
}
type CommentsDeleteCmd ¶
type CommentsDeleteCmd struct {
CommentID string `arg:"" required:"" help:"Comment ID"`
}
type CommentsListCmd ¶
type CommentsListCmd struct {
TaskID string `arg:"" required:"" help:"Task ID"`
}
type CommentsListCommentsCmd ¶
type CommentsListCommentsCmd struct {
ListID string `arg:"" required:"" help:"List ID"`
}
type CommentsRepliesCmd ¶
type CommentsRepliesCmd struct {
CommentID string `arg:"" required:"" help:"Comment ID"`
}
type CommentsReplyCmd ¶
type CommentsSubtypesCmd ¶
type CommentsSubtypesCmd struct {
TypeID string `arg:"" required:"" help:"Type ID"`
}
type CommentsUpdateCmd ¶
type CommentsViewCommentsCmd ¶
type DocsCmd ¶
type DocsCmd struct {
Search DocsSearchCmd `cmd:"" help:"Search for docs"`
Get DocsGetCmd `cmd:"" help:"Get a doc"`
PageListing DocsPageListingCmd `cmd:"" help:"Get doc page listing"`
Pages DocsPagesCmd `cmd:"" help:"Get all pages in a doc"`
Page DocsPageCmd `cmd:"" help:"Get a single page"`
Create DocsCreateCmd `cmd:"" help:"Create a doc"`
CreatePage DocsCreatePageCmd `cmd:"" help:"Create a page in a doc"`
EditPage DocsEditPageCmd `cmd:"" help:"Edit a page"`
}
type DocsCreateCmd ¶
type DocsCreatePageCmd ¶
type DocsCreatePageCmd struct {
DocID string `arg:"" help:"Doc ID" required:""`
Name string `name:"name" short:"n" help:"Page name" required:""`
Content string `name:"content" short:"c" help:"Page content (markdown)"`
ContentFormat string `name:"format" short:"f" help:"Content format (md or html)" default:"md"`
}
type DocsEditPageCmd ¶
type DocsEditPageCmd struct {
DocID string `arg:"" help:"Doc ID" required:""`
PageID string `arg:"" help:"Page ID" required:""`
Name string `name:"name" short:"n" help:"New page name"`
Content string `name:"content" short:"c" help:"New page content (replaces entire content)"`
ContentFormat string `name:"format" short:"f" help:"Content format (md or html)"`
}
type DocsGetCmd ¶
type DocsGetCmd struct {
DocID string `arg:"" help:"Doc ID" required:""`
}
type DocsPageCmd ¶
type DocsPageListingCmd ¶
type DocsPageListingCmd struct {
DocID string `arg:"" help:"Doc ID" required:""`
}
type DocsPagesCmd ¶
type DocsPagesCmd struct {
DocID string `arg:"" help:"Doc ID" required:""`
}
type DocsSearchCmd ¶
type DocsSearchCmd struct {
Query string `name:"query" short:"q" help:"Search query"`
}
type FieldsCmd ¶
type FieldsCmd struct {
List FieldsListCmd `cmd:"" help:"List custom fields"`
Set FieldsSetCmd `cmd:"" help:"Set a custom field value"`
Remove FieldsRemoveCmd `cmd:"" help:"Remove a custom field value"`
}
type FieldsListCmd ¶
type FieldsRemoveCmd ¶
type FieldsSetCmd ¶
type FoldersCmd ¶
type FoldersCmd struct {
Get FoldersGetCmd `cmd:"" help:"Get folder details"`
Create FoldersCreateCmd `cmd:"" help:"Create a new folder"`
Update FoldersUpdateCmd `cmd:"" help:"Update a folder"`
Delete FoldersDeleteCmd `cmd:"" help:"Delete a folder"`
FromTemplate FoldersFromTemplateCmd `cmd:"" help:"Create folder from template"`
}
type FoldersCreateCmd ¶
type FoldersDeleteCmd ¶
type FoldersDeleteCmd struct {
FolderID string `arg:"" required:"" help:"Folder ID"`
}
type FoldersFromTemplateCmd ¶
type FoldersGetCmd ¶
type FoldersGetCmd struct {
FolderID string `arg:"" required:"" help:"Folder ID"`
}
type FoldersUpdateCmd ¶
type GoalsAddKeyResultCmd ¶
type GoalsAddKeyResultCmd struct {
GoalID string `arg:"" required:"" help:"Goal ID"`
Name string `required:"" help:"Key result name"`
Type string `required:"" help:"Key result type (number, currency, boolean, percentage, automatic)"`
StepsStart int `help:"Start value for number/currency/percentage types"`
StepsEnd int `help:"End value for number/currency/percentage types"`
Unit string `help:"Unit of measurement"`
Owners string `help:"Comma-separated list of owner user IDs"`
}
type GoalsCmd ¶
type GoalsCmd struct {
List GoalsListCmd `cmd:"" help:"List goals"`
Get GoalsGetCmd `cmd:"" help:"Get goal details"`
Create GoalsCreateCmd `cmd:"" help:"Create a goal"`
Update GoalsUpdateCmd `cmd:"" help:"Update a goal"`
Delete GoalsDeleteCmd `cmd:"" help:"Delete a goal"`
AddKeyResult GoalsAddKeyResultCmd `cmd:"" help:"Add key result to goal"`
UpdateKeyResult GoalsUpdateKeyResultCmd `cmd:"" help:"Update key result progress"`
DeleteKeyResult GoalsDeleteKeyResultCmd `cmd:"" help:"Delete a key result"`
}
type GoalsCreateCmd ¶
type GoalsCreateCmd struct {
TeamID string `arg:"" required:"" help:"Workspace/Team ID"`
Name string `arg:"" required:"" help:"Goal name"`
DueDate int64 `help:"Due date in milliseconds"`
Description string `help:"Goal description"`
Owners string `help:"Comma-separated list of owner user IDs"`
Color string `name:"goal-color" help:"Goal color (hex)"`
}
type GoalsDeleteCmd ¶
type GoalsDeleteCmd struct {
GoalID string `arg:"" required:"" help:"Goal ID"`
}
type GoalsDeleteKeyResultCmd ¶
type GoalsDeleteKeyResultCmd struct {
KeyResultID string `arg:"" required:"" help:"Key result ID"`
}
type GoalsGetCmd ¶
type GoalsGetCmd struct {
GoalID string `arg:"" required:"" help:"Goal ID"`
}
type GoalsListCmd ¶
type GoalsUpdateCmd ¶
type GoalsUpdateCmd struct {
GoalID string `arg:"" required:"" help:"Goal ID"`
Name string `help:"New goal name"`
Description string `help:"New goal description"`
DueDate int64 `help:"New due date in milliseconds"`
Color string `name:"goal-color" help:"New goal color (hex)"`
AddOwners string `help:"Comma-separated list of owner IDs to add"`
RemoveOwners string `help:"Comma-separated list of owner IDs to remove"`
}
type GoalsUpdateKeyResultCmd ¶
type GroupsCmd ¶
type GroupsCmd struct {
List GroupsListCmd `cmd:"" help:"List user groups"`
Create GroupsCreateCmd `cmd:"" help:"Create a user group"`
Update GroupsUpdateCmd `cmd:"" help:"Update a user group"`
Delete GroupsDeleteCmd `cmd:"" help:"Delete a user group"`
}
type GroupsCreateCmd ¶
type GroupsDeleteCmd ¶
type GroupsDeleteCmd struct {
GroupID string `arg:"" required:"" help:"Group ID"`
}
type GroupsListCmd ¶
type GroupsListCmd struct{}
type GroupsUpdateCmd ¶
type GuestsAddToFolderCmd ¶
type GuestsAddToListCmd ¶
type GuestsAddToTaskCmd ¶
type GuestsCmd ¶
type GuestsCmd struct {
Get GuestsGetCmd `cmd:"" help:"Get a guest by ID"`
Invite GuestsInviteCmd `cmd:"" help:"Invite a guest to the workspace"`
Update GuestsUpdateCmd `cmd:"" help:"Update guest permissions"`
Remove GuestsRemoveCmd `cmd:"" help:"Remove a guest from the workspace"`
AddToTask GuestsAddToTaskCmd `cmd:"" help:"Add a guest to a task"`
RemoveFromTask GuestsRemoveFromTaskCmd `cmd:"" help:"Remove a guest from a task"`
AddToList GuestsAddToListCmd `cmd:"" help:"Add a guest to a list"`
RemoveFromList GuestsRemoveFromListCmd `cmd:"" help:"Remove a guest from a list"`
AddToFolder GuestsAddToFolderCmd `cmd:"" help:"Add a guest to a folder"`
RemoveFromFolder GuestsRemoveFromFolderCmd `cmd:"" help:"Remove a guest from a folder"`
}
type GuestsGetCmd ¶
type GuestsInviteCmd ¶
type GuestsInviteCmd struct {
TeamID string `arg:"" required:"" help:"Team (workspace) ID"`
Email string `arg:"" required:"" help:"Guest email address"`
CanEditTags bool `help:"Allow guest to edit tags"`
CanSeeTimeSpent bool `help:"Allow guest to see time spent"`
CanSeeTimeEstimated bool `help:"Allow guest to see time estimated"`
}
type GuestsRemoveCmd ¶
type GuestsRemoveFromFolderCmd ¶
type GuestsRemoveFromListCmd ¶
type GuestsRemoveFromTaskCmd ¶
type GuestsUpdateCmd ¶
type GuestsUpdateCmd struct {
TeamID string `arg:"" required:"" help:"Team (workspace) ID"`
GuestID int `arg:"" required:"" help:"Guest ID"`
CanEditTags *bool `help:"Allow guest to edit tags (true/false)"`
CanSeeTimeSpent *bool `help:"Allow guest to see time spent (true/false)"`
CanSeeTimeEstimated *bool `help:"Allow guest to see time estimated (true/false)"`
}
type ListsAddTaskCmd ¶
type ListsCmd ¶
type ListsCmd struct {
List ListsListCmd `cmd:"" help:"List all lists in a space or folder"`
Get ListsGetCmd `cmd:"" help:"Get list details"`
Create ListsCreateCmd `cmd:"" help:"Create a new list"`
Update ListsUpdateCmd `cmd:"" help:"Update a list"`
Delete ListsDeleteCmd `cmd:"" help:"Delete a list"`
FromTemplate ListsFromTemplateCmd `cmd:"" help:"Create list from template"`
AddTask ListsAddTaskCmd `cmd:"" help:"Add task to list"`
RemoveTask ListsRemoveTaskCmd `cmd:"" help:"Remove task from list"`
}
type ListsCreateCmd ¶
type ListsCreateCmd struct {
Name string `arg:"" required:"" help:"List name"`
Folder string `help:"Folder ID to create list in (required unless --space is set)"`
Space string `help:"Space ID for folderless list (required unless --folder is set)"`
Content string `help:"List description"`
DueDate int64 `help:"Due date in milliseconds"`
Priority int `help:"Priority (1-4)"`
Assignee int `help:"Assignee user ID"`
}
type ListsDeleteCmd ¶
type ListsDeleteCmd struct {
ListID string `arg:"" required:"" help:"List ID"`
}
type ListsFromTemplateCmd ¶
type ListsFromTemplateCmd struct {
TemplateID string `arg:"" required:"" help:"Template ID"`
Name string `arg:"" required:"" help:"New list name"`
Folder string `help:"Folder ID to create list in (required unless --space is set)"`
Space string `help:"Space ID for folderless list (required unless --folder is set)"`
}
type ListsGetCmd ¶
type ListsGetCmd struct {
ListID string `arg:"" required:"" help:"List ID"`
}
type ListsListCmd ¶
type ListsRemoveTaskCmd ¶
type ListsUpdateCmd ¶
type ListsUpdateCmd struct {
ListID string `arg:"" required:"" help:"List ID"`
Name string `help:"New list name"`
Content string `help:"List description"`
DueDate int64 `help:"Due date in milliseconds"`
Priority int `help:"Priority (1-4)"`
Assignee int `help:"Assignee user ID"`
UnsetAssignee bool `help:"Remove assignee from list"`
}
type MembersCmd ¶
type MembersCmd struct {
List MembersListCmd `cmd:"" help:"List all team members"`
ListMembers MembersListMembersCmd `cmd:"" help:"List members with access to a list"`
TaskMembers MembersTaskMembersCmd `cmd:"" help:"List members involved with a task"`
}
type MembersListCmd ¶
type MembersListCmd struct{}
type MembersListMembersCmd ¶
type MembersListMembersCmd struct {
List string `name:"list" help:"List ID" required:""`
}
type MembersTaskMembersCmd ¶
type MembersTaskMembersCmd struct {
Task string `name:"task" help:"Task ID" required:""`
}
type RelationshipsAddDepCmd ¶
type RelationshipsCmd ¶
type RelationshipsCmd struct {
AddDep RelationshipsAddDepCmd `cmd:"" help:"Add a task dependency"`
RemoveDep RelationshipsRemoveDepCmd `cmd:"" help:"Remove a task dependency"`
Link RelationshipsLinkCmd `cmd:"" help:"Link two tasks"`
Unlink RelationshipsUnlinkCmd `cmd:"" help:"Unlink two tasks"`
}
type RelationshipsLinkCmd ¶
type RelationshipsRemoveDepCmd ¶
type RelationshipsUnlinkCmd ¶
type RolesCmd ¶
type RolesCmd struct {
List RolesListCmd `cmd:"" help:"List custom roles"`
}
type RolesListCmd ¶
type RolesListCmd struct {
TeamID string `arg:"" required:"" help:"Team (workspace) ID"`
}
type RootFlags ¶
type RootFlags struct {
Color string `help:"Color output: auto|always|never" default:"${color}"`
JSON bool `help:"Output JSON to stdout (best for scripting)" default:"${json}"`
Plain bool `help:"Output stable, parseable text to stdout (TSV; no colors)" default:"${plain}"`
Force bool `help:"Skip confirmations for destructive commands"`
NoInput bool `help:"Never prompt; fail instead (useful for CI)"`
Verbose bool `help:"Enable verbose logging"`
Workspace string `help:"Workspace ID for v3 API calls (required for Chat, Docs, etc.)" default:"${workspace}"`
}
type SharedListCmd ¶
type SharedListCmd struct {
}
type SpacesCmd ¶
type SpacesCmd struct {
List SpacesListCmd `cmd:"" help:"List all spaces in the team"`
Get SpacesGetCmd `cmd:"" help:"Get space details"`
Create SpacesCreateCmd `cmd:"" help:"Create a new space"`
Update SpacesUpdateCmd `cmd:"" help:"Update a space"`
Delete SpacesDeleteCmd `cmd:"" help:"Delete a space"`
}
type SpacesCreateCmd ¶
type SpacesCreateCmd struct {
TeamID string `arg:"" required:"" help:"Team (workspace) ID"`
Name string `arg:"" required:"" help:"Space name"`
Private bool `help:"Make space private"`
Color string `name:"space-color" help:"Space color (hex)"`
MultipleAssignees bool `help:"Enable multiple assignees"`
}
type SpacesDeleteCmd ¶
type SpacesDeleteCmd struct {
SpaceID string `arg:"" required:"" help:"Space ID"`
}
type SpacesGetCmd ¶
type SpacesGetCmd struct {
SpaceID string `arg:"" required:"" help:"Space ID"`
}
type SpacesListCmd ¶
type SpacesListCmd struct{}
type SpacesUpdateCmd ¶
type SpacesUpdateCmd struct {
SpaceID string `arg:"" required:"" help:"Space ID"`
Name string `help:"New space name"`
Color string `name:"space-color" help:"Space color (hex)"`
Private bool `help:"Make space private"`
Public bool `help:"Make space public"`
MultipleAssignees bool `help:"Enable multiple assignees"`
}
type TagsAddCmd ¶
type TagsCmd ¶
type TagsCmd struct {
List TagsListCmd `cmd:"" help:"List tags in a space"`
Create TagsCreateCmd `cmd:"" help:"Create a tag in a space"`
Update TagsUpdateCmd `cmd:"" help:"Update a tag in a space"`
Delete TagsDeleteCmd `cmd:"" help:"Delete a tag from a space"`
Add TagsAddCmd `cmd:"" help:"Add a tag to a task"`
Remove TagsRemoveCmd `cmd:"" help:"Remove a tag from a task"`
}
type TagsCreateCmd ¶
type TagsDeleteCmd ¶
type TagsListCmd ¶
type TagsListCmd struct {
SpaceID string `required:"" help:"Space ID"`
}
type TagsRemoveCmd ¶
type TagsUpdateCmd ¶
type TaskTypesCmd ¶
type TaskTypesCmd struct {
List TaskTypesListCmd `cmd:"" help:"List custom task types"`
}
type TaskTypesListCmd ¶
type TaskTypesListCmd struct {
TeamID string `arg:"" required:"" help:"Team (workspace) ID"`
}
type TasksBulkTimeInStatusCmd ¶
type TasksBulkTimeInStatusCmd struct {
TaskIDs []string `arg:"" required:"" help:"Task IDs"`
}
TasksBulkTimeInStatusCmd gets time-in-status for multiple tasks.
type TasksCmd ¶
type TasksCmd struct {
List TasksListCmd `cmd:"" help:"List tasks in a list"`
Get TasksGetCmd `cmd:"" help:"Get a task by ID"`
Create TasksCreateCmd `cmd:"" help:"Create a new task"`
Update TasksUpdateCmd `cmd:"" help:"Update a task"`
Delete TasksDeleteCmd `cmd:"" help:"Delete a task"`
Search TasksSearchCmd `cmd:"" help:"Search tasks across workspace"`
TimeInStatus TasksTimeInStatusCmd `cmd:"" help:"Get time-in-status for a task"`
BulkTimeInStatus TasksBulkTimeInStatusCmd `cmd:"" help:"Get time-in-status for multiple tasks"`
Merge TasksMergeCmd `cmd:"" help:"Merge tasks into one"`
Move TasksMoveCmd `cmd:"" help:"Move a task to a different list"`
FromTemplate TasksFromTemplateCmd `cmd:"" help:"Create a task from a template"`
}
type TasksCreateCmd ¶
type TasksCreateCmd struct {
ListID string `arg:"" required:"" help:"List ID to create task in"`
Name string `arg:"" required:"" help:"Task name"`
Assignee int `help:"Assign to user ID"`
Priority *int `help:"Priority (1=urgent, 2=high, 3=normal, 4=low)"`
Due string `help:"Due date (unix timestamp in milliseconds)"`
}
type TasksDeleteCmd ¶
type TasksDeleteCmd struct {
TaskID string `arg:"" required:"" help:"Task ID"`
}
type TasksFromTemplateCmd ¶
type TasksFromTemplateCmd struct {
ListID string `arg:"" required:"" help:"List ID to create task in"`
TemplateID string `arg:"" required:"" help:"Template ID"`
Name string `help:"Override task name"`
}
TasksFromTemplateCmd creates a task from a template.
type TasksGetCmd ¶
type TasksGetCmd struct {
TaskID string `arg:"" required:"" help:"Task ID"`
}
type TasksListCmd ¶
type TasksMergeCmd ¶
type TasksMergeCmd struct {
TargetTaskID string `arg:"" required:"" help:"Target task ID to merge into"`
SourceTaskIDs []string `required:"" help:"Source task IDs to merge (comma-separated or repeated --source)"`
}
TasksMergeCmd merges tasks into one.
type TasksMoveCmd ¶
type TasksMoveCmd struct {
TaskID string `arg:"" required:"" help:"Task ID to move"`
ListID string `required:"" help:"Target list ID"`
}
TasksMoveCmd moves a task to a different list.
type TasksSearchCmd ¶
type TasksSearchCmd struct {
TeamID string `required:"" help:"Team ID to search within"`
Status []string `help:"Filter by status (can be repeated)"`
Assignee []int `help:"Filter by assignee user ID (can be repeated)"`
Tag []string `help:"Filter by tag (can be repeated)"`
DueDateGt int64 `help:"Due date greater than (unix ms)"`
DueDateLt int64 `help:"Due date less than (unix ms)"`
IncludeClosed bool `help:"Include closed tasks"`
Page int `help:"Page number (0-indexed)"`
OrderBy string `help:"Order by field (e.g. due_date, created)"`
}
TasksSearchCmd searches for tasks across a workspace.
type TasksTimeInStatusCmd ¶
type TasksTimeInStatusCmd struct {
TaskID string `arg:"" required:"" help:"Task ID"`
}
TasksTimeInStatusCmd gets time-in-status for a single task.
type TasksUpdateCmd ¶
type TasksUpdateCmd struct {
TaskID string `arg:"" required:"" help:"Task ID"`
Status string `help:"New status"`
Name string `help:"New name"`
Assignee int `help:"Assign to user ID (adds assignee)"`
Unassign int `help:"Unassign user ID (removes assignee)"`
Priority *int `help:"New priority (1=urgent, 2=high, 3=normal, 4=low)"`
}
type TemplatesCmd ¶
type TemplatesCmd struct {
List TemplatesListCmd `cmd:"" help:"List task templates"`
}
type TemplatesListCmd ¶
type TimeAddTagsCmd ¶
type TimeCmd ¶
type TimeCmd struct {
Log TimeLogCmd `cmd:"" help:"Log time to a task"`
List TimeListCmd `cmd:"" help:"List time entries for a task"`
Get TimeGetCmd `cmd:"" help:"Get a single time entry"`
Current TimeCurrentCmd `cmd:"" help:"Get the currently running timer"`
Start TimeStartCmd `cmd:"" help:"Start a new timer"`
Stop TimeStopCmd `cmd:"" help:"Stop the currently running timer"`
Update TimeUpdateCmd `cmd:"" help:"Update a time entry"`
Delete TimeDeleteCmd `cmd:"" help:"Delete a time entry"`
History TimeHistoryCmd `cmd:"" help:"Get time entry change history"`
Tags TimeTagsCmd `cmd:"" help:"List all time entry tags"`
AddTags TimeAddTagsCmd `cmd:"" help:"Add tags to time entries"`
RemoveTags TimeRemoveTagsCmd `cmd:"" help:"Remove tags from time entries"`
RenameTag TimeRenameTagCmd `cmd:"" help:"Rename a time entry tag"`
}
type TimeCurrentCmd ¶
type TimeCurrentCmd struct{}
type TimeDeleteCmd ¶
type TimeDeleteCmd struct {
EntryID string `arg:"" required:"" help:"Time entry ID"`
}
type TimeGetCmd ¶
type TimeGetCmd struct {
EntryID string `arg:"" required:"" help:"Time entry ID"`
}
type TimeHistoryCmd ¶
type TimeHistoryCmd struct {
EntryID string `arg:"" required:"" help:"Time entry ID"`
}
type TimeLegacyCmd ¶
type TimeLegacyCmd struct {
List TimeLegacyListCmd `cmd:"" help:"List tracked time for a task"`
Track TimeLegacyTrackCmd `cmd:"" help:"Track time on a task"`
Update TimeLegacyUpdateCmd `cmd:"" help:"Update tracked time"`
Delete TimeLegacyDeleteCmd `cmd:"" help:"Delete tracked time"`
}
type TimeLegacyDeleteCmd ¶
type TimeLegacyListCmd ¶
type TimeLegacyTrackCmd ¶
type TimeLegacyUpdateCmd ¶
type TimeListCmd ¶
type TimeListCmd struct {
TaskID string `arg:"" required:"" help:"Task ID"`
}
type TimeLogCmd ¶
type TimeRemoveTagsCmd ¶
type TimeRenameTagCmd ¶
type TimeStartCmd ¶
type TimeStopCmd ¶
type TimeStopCmd struct{}
type TimeTagsCmd ¶
type TimeTagsCmd struct{}
type TimeUpdateCmd ¶
type TimeUpdateCmd struct {
EntryID string `arg:"" required:"" help:"Time entry ID"`
Description string `help:"New description"`
Duration int64 `help:"New duration in milliseconds"`
Start int64 `help:"New start time in milliseconds"`
End int64 `help:"New end time in milliseconds"`
Billable *bool `help:"Mark as billable (true/false)"`
TagAction string `help:"Tag action: 'add' or 'remove'"`
Tags []string `help:"Tags to add or remove"`
}
type UsersCmd ¶
type UsersCmd struct {
Get UsersGetCmd `cmd:"" help:"Get user details"`
Invite UsersInviteCmd `cmd:"" help:"Invite user to workspace"`
Update UsersUpdateCmd `cmd:"" help:"Update user role"`
Remove UsersRemoveCmd `cmd:"" help:"Remove user from workspace"`
}
type UsersGetCmd ¶
type UsersInviteCmd ¶
type UsersRemoveCmd ¶
type UsersUpdateCmd ¶
type VersionCmd ¶
type VersionCmd struct{}
type ViewsCmd ¶
type ViewsCmd struct {
List ViewsListCmd `cmd:"" help:"List views"`
Get ViewsGetCmd `cmd:"" help:"Get a view by ID"`
Tasks ViewsTasksCmd `cmd:"" help:"Get tasks in a view"`
Create ViewsCreateCmd `cmd:"" help:"Create a new view"`
Update ViewsUpdateCmd `cmd:"" help:"Update a view"`
Delete ViewsDeleteCmd `cmd:"" help:"Delete a view"`
}
type ViewsCreateCmd ¶
type ViewsCreateCmd struct {
Team string `help:"Create view in a workspace/team"`
Space string `help:"Create view in a space"`
Folder string `help:"Create view in a folder"`
List string `help:"Create view in a list"`
Name string `arg:"" required:"" help:"View name"`
Type string `required:"" help:"View type (list, board, calendar, gantt, activity, map, workload, table)"`
}
type ViewsDeleteCmd ¶
type ViewsDeleteCmd struct {
ViewID string `arg:"" required:"" help:"View ID"`
}
type ViewsGetCmd ¶
type ViewsGetCmd struct {
ViewID string `arg:"" required:"" help:"View ID"`
}
type ViewsListCmd ¶
type ViewsTasksCmd ¶
type ViewsUpdateCmd ¶
type WebhooksCmd ¶
type WebhooksCmd struct {
List WebhooksListCmd `cmd:"" help:"List webhooks"`
Create WebhooksCreateCmd `cmd:"" help:"Create a webhook"`
Update WebhooksUpdateCmd `cmd:"" help:"Update a webhook"`
Delete WebhooksDeleteCmd `cmd:"" help:"Delete a webhook"`
}
type WebhooksCreateCmd ¶
type WebhooksCreateCmd struct {
TeamID string `arg:"" required:"" help:"Workspace/Team ID"`
Endpoint string `required:"" help:"Webhook endpoint URL"`
Events string `required:"" help:"Comma-separated list of events"`
Space string `help:"Scope to space ID"`
Folder string `help:"Scope to folder ID"`
List string `help:"Scope to list ID"`
Task string `help:"Scope to task ID"`
}
type WebhooksDeleteCmd ¶
type WebhooksDeleteCmd struct {
WebhookID string `arg:"" required:"" help:"Webhook ID"`
}
type WebhooksListCmd ¶
type WebhooksListCmd struct {
TeamID string `arg:"" required:"" help:"Workspace/Team ID"`
}
type WebhooksUpdateCmd ¶
type WorkspacesCmd ¶
type WorkspacesCmd struct {
List WorkspacesListCmd `cmd:"" help:"List workspaces (teams)"`
Plan WorkspacesPlanCmd `cmd:"" help:"Get workspace plan"`
Seats WorkspacesSeatsCmd `cmd:"" help:"Get workspace seat usage"`
}
type WorkspacesListCmd ¶
type WorkspacesListCmd struct{}
type WorkspacesPlanCmd ¶
type WorkspacesPlanCmd struct {
TeamID string `arg:"" required:"" help:"Team (workspace) ID"`
}
type WorkspacesSeatsCmd ¶
type WorkspacesSeatsCmd struct {
TeamID string `arg:"" required:"" help:"Team (workspace) ID"`
}
Source Files
¶
- acls.go
- attachments.go
- auditlogs.go
- auth.go
- chat.go
- checklists.go
- comments.go
- docs.go
- fields.go
- folders.go
- goals.go
- groups.go
- guests.go
- helpers.go
- lists.go
- members.go
- relationships.go
- roles.go
- root.go
- shared.go
- spaces.go
- tags.go
- tasks.go
- tasktypes.go
- templates.go
- time.go
- time_legacy.go
- users.go
- version.go
- views.go
- webhooks.go
- workspaces.go
Click to show internal directories.
Click to hide internal directories.