@nikcli-ai/sdk 1.276.0 → 1.277.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (79) hide show
  1. package/dist/httpapi/client.d.ts +73 -0
  2. package/dist/httpapi/client.js +27 -0
  3. package/dist/httpapi/compat.d.ts +484 -0
  4. package/dist/httpapi/compat.js +507 -0
  5. package/dist/httpapi/generated/client.d.ts +142 -140
  6. package/dist/httpapi/generated/client.js +833 -817
  7. package/dist/httpapi/generated/types.d.ts +7014 -3518
  8. package/dist/httpapi/index.d.ts +1063 -1
  9. package/dist/httpapi/index.js +13 -1
  10. package/dist/index.d.ts +1 -10
  11. package/dist/index.js +1 -16
  12. package/dist/server.d.ts +1 -1
  13. package/package.json +4 -20
  14. package/dist/client.d.ts +0 -7
  15. package/dist/client.js +0 -25
  16. package/dist/gen/client/client.gen.d.ts +0 -2
  17. package/dist/gen/client/client.gen.js +0 -165
  18. package/dist/gen/client/index.d.ts +0 -7
  19. package/dist/gen/client/index.js +0 -5
  20. package/dist/gen/client/types.gen.d.ts +0 -127
  21. package/dist/gen/client/types.gen.js +0 -2
  22. package/dist/gen/client/utils.gen.d.ts +0 -38
  23. package/dist/gen/client/utils.gen.js +0 -226
  24. package/dist/gen/client.gen.d.ts +0 -12
  25. package/dist/gen/client.gen.js +0 -5
  26. package/dist/gen/core/auth.gen.d.ts +0 -18
  27. package/dist/gen/core/auth.gen.js +0 -14
  28. package/dist/gen/core/bodySerializer.gen.d.ts +0 -17
  29. package/dist/gen/core/bodySerializer.gen.js +0 -57
  30. package/dist/gen/core/params.gen.d.ts +0 -33
  31. package/dist/gen/core/params.gen.js +0 -89
  32. package/dist/gen/core/pathSerializer.gen.d.ts +0 -33
  33. package/dist/gen/core/pathSerializer.gen.js +0 -106
  34. package/dist/gen/core/serverSentEvents.gen.d.ts +0 -59
  35. package/dist/gen/core/serverSentEvents.gen.js +0 -117
  36. package/dist/gen/core/types.gen.d.ts +0 -78
  37. package/dist/gen/core/types.gen.js +0 -2
  38. package/dist/gen/core/utils.gen.d.ts +0 -14
  39. package/dist/gen/core/utils.gen.js +0 -69
  40. package/dist/gen/sdk.gen.d.ts +0 -403
  41. package/dist/gen/sdk.gen.js +0 -881
  42. package/dist/gen/types.gen.d.ts +0 -3380
  43. package/dist/gen/types.gen.js +0 -2
  44. package/dist/v2/client.d.ts +0 -8
  45. package/dist/v2/client.js +0 -33
  46. package/dist/v2/gen/client/client.gen.d.ts +0 -2
  47. package/dist/v2/gen/client/client.gen.js +0 -214
  48. package/dist/v2/gen/client/index.d.ts +0 -10
  49. package/dist/v2/gen/client/index.js +0 -6
  50. package/dist/v2/gen/client/types.gen.d.ts +0 -120
  51. package/dist/v2/gen/client/types.gen.js +0 -2
  52. package/dist/v2/gen/client/utils.gen.d.ts +0 -37
  53. package/dist/v2/gen/client/utils.gen.js +0 -226
  54. package/dist/v2/gen/client.gen.d.ts +0 -12
  55. package/dist/v2/gen/client.gen.js +0 -3
  56. package/dist/v2/gen/core/auth.gen.d.ts +0 -25
  57. package/dist/v2/gen/core/auth.gen.js +0 -14
  58. package/dist/v2/gen/core/bodySerializer.gen.d.ts +0 -25
  59. package/dist/v2/gen/core/bodySerializer.gen.js +0 -57
  60. package/dist/v2/gen/core/params.gen.d.ts +0 -43
  61. package/dist/v2/gen/core/params.gen.js +0 -109
  62. package/dist/v2/gen/core/pathSerializer.gen.d.ts +0 -33
  63. package/dist/v2/gen/core/pathSerializer.gen.js +0 -106
  64. package/dist/v2/gen/core/queryKeySerializer.gen.d.ts +0 -18
  65. package/dist/v2/gen/core/queryKeySerializer.gen.js +0 -93
  66. package/dist/v2/gen/core/serverSentEvents.gen.d.ts +0 -71
  67. package/dist/v2/gen/core/serverSentEvents.gen.js +0 -132
  68. package/dist/v2/gen/core/types.gen.d.ts +0 -83
  69. package/dist/v2/gen/core/types.gen.js +0 -2
  70. package/dist/v2/gen/core/utils.gen.d.ts +0 -19
  71. package/dist/v2/gen/core/utils.gen.js +0 -87
  72. package/dist/v2/gen/sdk.gen.d.ts +0 -3367
  73. package/dist/v2/gen/sdk.gen.js +0 -6914
  74. package/dist/v2/gen/types.gen.d.ts +0 -11330
  75. package/dist/v2/gen/types.gen.js +0 -2
  76. package/dist/v2/index.d.ts +0 -10
  77. package/dist/v2/index.js +0 -16
  78. package/dist/v2/server.d.ts +0 -23
  79. package/dist/v2/server.js +0 -94
@@ -1,3367 +0,0 @@
1
- import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type ServerSentEventsResult, type TDataShape } from "./client/index.js";
2
- import type { AgentPartInput, AnalyticsDailyResponses, AnalyticsDataResponses, AnalyticsGlobalResponses, AnalyticsLeaderboardResponses, AnalyticsSessionErrors, AnalyticsSessionResponses, AnalyticsSessionsResponses, AppAgentsResponses, AppLogErrors, AppLogResponses, AppSkillCreateErrors, AppSkillCreateResponses, AppSkillDeleteErrors, AppSkillDeleteResponses, AppSkillsResponses, Auth as Auth7, AuthRemoveErrors, AuthRemoveResponses, AuthSetErrors, AuthSetResponses, BrainStatusResponses, BrainTriggerErrors, BrainTriggerInput, BrainTriggerResponses, CommandListResponses, Config as Config3, ConfigGetResponses, ConfigProvidersResponses, ConfigReloadResponses, ConfigUpdateErrors, ConfigUpdateResponses, ConnectorsAuthRemoveErrors, ConnectorsAuthRemoveResponses, ConnectorsAuthSetErrors, ConnectorsAuthSetResponses, ConnectorsInvalidateResponses, ConnectorsStatusResponses, DeleteConfigMcpNameResponses, DoctorRunResponses, EventSubscribeResponse, EventSubscribeResponses, EventTuiCommandExecute, EventTuiPromptAppend, EventTuiSessionSelect, EventTuiToastShow, ExperimentalResourceListResponses, ExperimentalWorkspaceAdaptorListResponses, ExperimentalWorkspaceCreateErrors, ExperimentalWorkspaceCreateResponses, ExperimentalWorkspaceEventsErrors, ExperimentalWorkspaceEventsResponses, ExperimentalWorkspaceListResponses, ExperimentalWorkspaceRemoveErrors, ExperimentalWorkspaceRemoveResponses, ExperimentalWorkspaceRestoreErrors, ExperimentalWorkspaceRestoreResponses, ExperimentalWorkspaceSessionRestoreErrors, ExperimentalWorkspaceSessionRestoreResponses, ExperimentalWorkspaceSessionWarpErrors, ExperimentalWorkspaceSessionWarpResponses, ExperimentalWorkspaceStatusResponses, ExperimentalWorkspaceSyncListResponses, ExperimentalWorkspaceWarpErrors, ExperimentalWorkspaceWarpResponses, FileListResponses, FilePartInput, FileReadResponses, FileStatusResponses, FileWriteResponses, FindFilesResponses, FindSymbolsResponses, FindTextResponses, FormatterStatusResponses, GetApiShareShareIdDataResponses, GetApiShareShareIdResponses, GetShareShareIdResponses, GetSShareIdResponses, GlobalDisposeResponses, GlobalEventResponse, GlobalEventResponses, GlobalHealthResponses, InstanceDisposeResponses, LoopAbortErrors, LoopAbortResponses, LoopDeleteErrors, LoopDeleteResponses, LoopGenerateErrors, LoopGenerateResponses, LoopGetErrors, LoopGetResponses, LoopListErrors, LoopListResponses, LoopPauseResponses, LoopRecentRunsResponses, LoopResumeErrors, LoopResumeResponses, LoopRunErrors, LoopRunResponses, LoopRunsResponses, LoopTemplatesResponses, LoopToggleErrors, LoopToggleResponses, LoopUpdateErrors, LoopUpdateResponses, LoopUpsertErrors, LoopUpsertResponses, LspStatusResponses, ManagedWorktreeAncestorsErrors, ManagedWorktreeAncestorsResponses, ManagedWorktreeChildrenErrors, ManagedWorktreeChildrenResponses, ManagedWorktreeCreateErrors, ManagedWorktreeCreateInput, ManagedWorktreeCreateResponses, ManagedWorktreeLinkErrors, ManagedWorktreeLinkInput, ManagedWorktreeLinkResponses, ManagedWorktreeListErrors, ManagedWorktreeListResponses, ManagedWorktreeRemoveErrors, ManagedWorktreeRemoveInput, ManagedWorktreeRemoveResponses, McpAddErrors, McpAddResponses, McpAuthAuthenticateErrors, McpAuthAuthenticateResponses, McpAuthCallbackErrors, McpAuthCallbackResponses, McpAuthRemoveErrors, McpAuthRemoveResponses, McpAuthStartErrors, McpAuthStartResponses, McpConnectResponses, McpDisconnectResponses, McpLocalConfig, McpRemoteConfig, McpStatusResponses, McpToggleErrors, McpToggleResponses, Message, MissionCancelErrors, MissionCancelResponses, MissionDeleteErrors, MissionDeleteResponses, MissionExecsResponses, MissionFeatureMutateErrors, MissionFeatureMutateResponses, MissionGenerateErrors, MissionGenerateResponses, MissionGetErrors, MissionGetResponses, MissionListResponses, MissionPauseErrors, MissionPauseResponses, MissionRecentExecsResponses, MissionStartErrors, MissionStartResponses, MissionTemplatesResponses, MissionUpdateErrors, MissionUpdateResponses, MissionUpsertErrors, MissionUpsertResponses, MobileAuthTokenCreateResponses, MobileAuthTokenListResponses, MobileAuthTokenRevokeResponses, MobileBootstrapResponses, MobileCommandListResponses, MobileGitBranchesResponses, MobileGitCheckoutErrors, MobileGitCheckoutResponses, MobileGitCommitErrors, MobileGitCommitResponses, MobileGitCommitsResponses, MobileGitDiffResponses, MobileGitDiscardResponses, MobileGithubAuthRemoveResponses, MobileGithubAuthSetErrors, MobileGithubAuthSetResponses, MobileGithubBranchesResponses, MobileGithubDeviceAuthPollInput, MobileGithubImportErrors, MobileGithubImportRequest, MobileGithubImportResponses, MobileGithubImportsResponses, MobileGithubOauthClientIdSetErrors, MobileGithubOauthClientIdSetResponses, MobileGithubOauthDevicePollErrors, MobileGithubOauthDevicePollResponses, MobileGithubOauthDeviceStartErrors, MobileGithubOauthDeviceStartResponses, MobileGithubPublishInput, MobileGithubReposResponses, MobileGithubSessionCleanupErrors, MobileGithubSessionCleanupResponses, MobileGithubSessionCreateErrors, MobileGithubSessionCreateInput, MobileGithubSessionCreateResponses, MobileGithubSessionPublishErrors, MobileGithubSessionPublishResponses, MobileGitPullErrors, MobileGitPullResponses, MobileGitPushErrors, MobileGitPushResponses, MobileGitStageResponses, MobileGitStatusResponses, MobileGitUnstageResponses, MobileLoopAbortErrors, MobileLoopAbortResponses, MobileLoopCreateErrors, MobileLoopCreateResponses, MobileLoopDeleteErrors, MobileLoopDeleteResponses, MobileLoopGenerateErrors, MobileLoopGenerateInput, MobileLoopGenerateResponses, MobileLoopGetErrors, MobileLoopGetResponses, MobileLoopListErrors, MobileLoopListResponses, MobileLoopPauseErrors, MobileLoopPauseResponses, MobileLoopResumeErrors, MobileLoopResumeResponses, MobileLoopRunErrors, MobileLoopRunResponses, MobileLoopRunsErrors, MobileLoopRunsRecentErrors, MobileLoopRunsRecentResponses, MobileLoopRunsResponses, MobileLoopTemplatesResponses, MobileLoopToggleErrors, MobileLoopToggleResponses, MobileLoopUpdateErrors, MobileLoopUpdateResponses, MobileLoopWriteInput, MobileMemoryHistoryResponses, MobileMemorySearchResponses, MobileMemoryStashCreateErrors, MobileMemoryStashCreateResponses, MobileMemoryStashDeleteErrors, MobileMemoryStashDeleteResponses, MobileMemoryStashListResponses, MobilePermissionRespondResponses, MobileProjectListResponses, MobilePromptStashCreateInput, MobilePtyConnectErrors, MobilePtyConnectResponses, MobilePtyCreateErrors, MobilePtyCreateResponses, MobilePtyGetErrors, MobilePtyGetResponses, MobilePtyListResponses, MobilePtyRemoveErrors, MobilePtyRemoveResponses, MobilePtyUpdateErrors, MobilePtyUpdateResponses, MobileQuestionRejectResponses, MobileQuestionRespondResponses, MobileRoutineCreateErrors, MobileRoutineCreateInput, MobileRoutineCreateResponses, MobileRoutineDeleteErrors, MobileRoutineDeleteResponses, MobileRoutineGetErrors, MobileRoutineGetResponses, MobileRoutineListErrors, MobileRoutineListResponses, MobileRoutinePauseErrors, MobileRoutinePauseResponses, MobileRoutineResumeErrors, MobileRoutineResumeResponses, MobileRoutineRunErrors, MobileRoutineRunInput, MobileRoutineRunResponses, MobileRoutineTriggerErrors, MobileRoutineTriggerInput, MobileRoutineTriggerResponses, MobileRoutineUpdateErrors, MobileRoutineUpdateInput, MobileRoutineUpdateResponses, MobileSessionAbortResponses, MobileSessionCommandErrors, MobileSessionCommandInput, MobileSessionCommandListErrors, MobileSessionCommandListResponses, MobileSessionCommandResponses, MobileSessionCreateErrors, MobileSessionCreateInput, MobileSessionCreateResponses, MobileSessionDeleteErrors, MobileSessionDeleteResponses, MobileSessionDetailErrors, MobileSessionDetailResponses, MobileSessionDiffResponses, MobileSessionListResponses, MobileSessionMessageErrors, MobileSessionMessageResponses, MobileSessionRenameResponses, MobileSessionStreamResponses, MobileSessionTeleportErrors, MobileSessionTeleportOutErrors, MobileSessionTeleportOutResponses, MobileSessionTeleportResponses, MobileSessionTeleportUploadBeginResponses, MobileSessionTeleportUploadChunkErrors, MobileSessionTeleportUploadChunkResponses, MobileWorktreeCreateErrors, MobileWorktreeCreateResponses, MobileWorktreeRemoveResponses, MobileWorktreeResetResponses, OutputFormat, Part as Part2, PartDeleteErrors, PartDeleteResponses, PartUpdateErrors, PartUpdateResponses, PatchConfigMcpNameResponses, PatchUserIdResponses, PathGetResponses, PermissionListResponses, PermissionReplyErrors, PermissionReplyResponses, PermissionRespondErrors, PermissionRespondResponses, PermissionRuleset, PostConfigMcpResponses, PostConfigProfilesActivateNameResponses, PostConfigProfilesResponses, PostUserLoginResponses, PostUserRegisterResponses, ProjectCurrentResponses, ProjectListResponses, ProjectUpdateErrors, ProjectUpdateResponses, ProviderApiSetErrors, ProviderApiSetResponses, ProviderAuthRemoveResponses, ProviderAuthResponses, ProviderListResponses, ProviderOauthAuthorizeErrors, ProviderOauthAuthorizeResponses, ProviderOauthCallbackErrors, ProviderOauthCallbackResponses, PtyConnectErrors, PtyConnectResponses, PtyCreateErrors, PtyCreateResponses, PtyGetErrors, PtyGetResponses, PtyListResponses, PtyRemoveErrors, PtyRemoveResponses, PtyUpdateErrors, PtyUpdateResponses, QuestionAnswer, QuestionListResponses, QuestionRejectErrors, QuestionRejectResponses, QuestionReplyErrors, QuestionReplyResponses, SessionAbortErrors, SessionAbortResponses, SessionBackgroundCancelErrors, SessionBackgroundCancelResponses, SessionBackgroundErrors, SessionBackgroundInspectErrors, SessionBackgroundInspectResponses, SessionBackgroundReadErrors, SessionBackgroundReadResponses, SessionBackgroundResponses, SessionChildrenErrors, SessionChildrenResponses, SessionCommandErrors, SessionCommandResponses, SessionContextErrors, SessionContextResponses, SessionContextToggleErrors, SessionContextToggleResponses, SessionCreateErrors, SessionCreateResponses, SessionDeleteErrors, SessionDeleteResponses, SessionDiffResponses, SessionForkResponses, SessionGetErrors, SessionGetResponses, SessionGithub, SessionGoalErrors, SessionGoalResponses, SessionInstructionsErrors, SessionInstructionsResponses, SessionListResponses, SessionMessageErrors, SessionMessageResponses, SessionMessagesErrors, SessionMessagesResponses, SessionMonitorCancelErrors, SessionMonitorCancelResponses, SessionMonitorErrors, SessionMonitorLogErrors, SessionMonitorLogResponses, SessionMonitorResponses, SessionPromptAsyncErrors, SessionPromptAsyncResponses, SessionPromptErrors, SessionPromptResponses, SessionRevertErrors, SessionRevertResponses, SessionShareErrors, SessionShareResponses, SessionShellErrors, SessionShellResponses, SessionStatusErrors, SessionStatusResponses, SessionSummarizeErrors, SessionSummarizeResponses, SessionTodoErrors, SessionTodoResponses, SessionUnrevertErrors, SessionUnrevertResponses, SessionUnshareErrors, SessionUnshareResponses, SessionUpdateErrors, SessionUpdateResponses, SessionV2EntriesErrors, SessionV2EntriesResponses, SessionV2EventsErrors, SessionV2EventsResponses, SessionV2StateErrors, SessionV2StateResponses, SessionWorktree, SubtaskPartInput, SyncConfigSetErrors, SyncConfigSetResponses, SyncConnectResponses, SyncDisconnectResponses, SyncDrainResponses, SyncEventPushErrors, SyncEventPushResponses, SyncEventStreamResponses, SyncOutboxListResponses, SyncSnapshotGetErrors, SyncSnapshotGetResponses, SyncStatsResponses, TextPartInput, ToolIdsErrors, ToolIdsResponses, ToolListErrors, ToolListResponses, TuiAppendPromptErrors, TuiAppendPromptResponses, TuiClearPromptResponses, TuiControlNextResponses, TuiControlResponseResponses, TuiExecuteCommandErrors, TuiExecuteCommandResponses, TuiOpenHelpResponses, TuiOpenModelsResponses, TuiOpenSessionsResponses, TuiOpenThemesResponses, TuiPublishErrors, TuiPublishResponses, TuiSelectSessionErrors, TuiSelectSessionResponses, TuiShowToastResponses, TuiSubmitPromptResponses, VcsApplyErrors, VcsApplyInput, VcsApplyResponses, VcsDiffRawResponses, VcsGetResponses, VcsStatusResponses, WorktreeCreateErrors, WorktreeCreateInput, WorktreeCreateResponses, WorktreeListResponses, WorktreeRemoveErrors, WorktreeRemoveInput, WorktreeRemoveResponses, WorktreeResetErrors, WorktreeResetInput, WorktreeResetResponses } from "./types.gen.js";
3
- export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
4
- /**
5
- * You can provide a client instance returned by `createClient()` instead of
6
- * individual options. This might be also useful if you want to implement a
7
- * custom client.
8
- */
9
- client?: Client;
10
- /**
11
- * You can pass arbitrary values through the `meta` object. This can be
12
- * used to access values that aren't defined as part of the SDK function.
13
- */
14
- meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
15
- };
16
- declare class HeyApiClient {
17
- protected client: Client;
18
- constructor(args?: {
19
- client?: Client;
20
- });
21
- }
22
- declare class HeyApiRegistry<T> {
23
- private readonly defaultKey;
24
- private readonly instances;
25
- get(key?: string): T;
26
- set(value: T, key?: string): void;
27
- }
28
- export declare class Global extends HeyApiClient {
29
- /**
30
- * Get health
31
- *
32
- * Get health information about the Nikcli server.
33
- */
34
- health<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<GlobalHealthResponses, unknown, ThrowOnError>;
35
- /**
36
- * Get global events
37
- *
38
- * Subscribe to global events from the Nikcli system using server-sent events.
39
- */
40
- event<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError, GlobalEventResponse>): Promise<ServerSentEventsResult<GlobalEventResponses>>;
41
- /**
42
- * Dispose instance
43
- *
44
- * Clean up and dispose all Nikcli instances, releasing all resources.
45
- */
46
- dispose<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<GlobalDisposeResponses, unknown, ThrowOnError>;
47
- }
48
- export declare class Project extends HeyApiClient {
49
- /**
50
- * List all projects
51
- *
52
- * Get a list of projects that have been opened with Nikcli.
53
- */
54
- list<ThrowOnError extends boolean = false>(parameters?: {
55
- directory?: string;
56
- workspace?: string;
57
- }, options?: Options<never, ThrowOnError>): RequestResult<ProjectListResponses, unknown, ThrowOnError>;
58
- /**
59
- * Get current project
60
- *
61
- * Retrieve the currently active project that Nikcli is working with.
62
- */
63
- current<ThrowOnError extends boolean = false>(parameters?: {
64
- directory?: string;
65
- workspace?: string;
66
- }, options?: Options<never, ThrowOnError>): RequestResult<ProjectCurrentResponses, unknown, ThrowOnError>;
67
- /**
68
- * Update project
69
- *
70
- * Update project properties such as name, icon and color.
71
- */
72
- update<ThrowOnError extends boolean = false>(parameters: {
73
- projectID: string;
74
- directory?: string;
75
- workspace?: string;
76
- name?: string;
77
- icon?: {
78
- url?: string;
79
- override?: string;
80
- color?: string;
81
- };
82
- }, options?: Options<never, ThrowOnError>): RequestResult<ProjectUpdateResponses, ProjectUpdateErrors, ThrowOnError>;
83
- }
84
- export declare class Loop extends HeyApiClient {
85
- /**
86
- * List loops
87
- *
88
- * List all loops defined for the current project, with live runtime status.
89
- */
90
- list<ThrowOnError extends boolean = false>(parameters?: {
91
- directory?: string;
92
- workspace?: string;
93
- }, options?: Options<never, ThrowOnError>): RequestResult<LoopListResponses, LoopListErrors, ThrowOnError>;
94
- /**
95
- * Create or update a loop
96
- *
97
- * Persist a loop definition. Generates the id and createdAt for new loops.
98
- */
99
- upsert<ThrowOnError extends boolean = false>(parameters: {
100
- directory?: string;
101
- workspace?: string;
102
- name: string;
103
- stages: Array<{
104
- name: string;
105
- agent: string;
106
- model?: string;
107
- objective: string;
108
- tokenBudget?: number;
109
- }>;
110
- trigger: {
111
- kind: "manual";
112
- } | {
113
- kind: "interval";
114
- everyMs: number;
115
- };
116
- maxRuns?: number;
117
- timeoutMs?: number;
118
- createPR?: boolean;
119
- sandbox?: boolean;
120
- worktree?: {
121
- name: string;
122
- branch?: string;
123
- directory: string;
124
- };
125
- paused?: boolean;
126
- enabled: boolean;
127
- }, options?: Options<never, ThrowOnError>): RequestResult<LoopUpsertResponses, LoopUpsertErrors, ThrowOnError>;
128
- /**
129
- * List loop templates
130
- *
131
- * Built-in starter pipelines the user can instantiate from the wizard.
132
- */
133
- templates<ThrowOnError extends boolean = false>(parameters?: {
134
- directory?: string;
135
- workspace?: string;
136
- }, options?: Options<never, ThrowOnError>): RequestResult<LoopTemplatesResponses, unknown, ThrowOnError>;
137
- /**
138
- * Generate a loop from a description
139
- *
140
- * Send a natural-language description to an AI and parse the response back into a fully-formed loop definition. The response is a draft — the user still confirms before persistence.
141
- */
142
- generate<ThrowOnError extends boolean = false>(parameters: {
143
- directory?: string;
144
- workspace?: string;
145
- description: string;
146
- model?: string;
147
- agent?: string;
148
- }, options?: Options<never, ThrowOnError>): RequestResult<LoopGenerateResponses, LoopGenerateErrors, ThrowOnError>;
149
- /**
150
- * Delete a loop
151
- *
152
- * Remove a loop and its run history. Cancels any in-flight run, disarms its scheduler entry, and cascade-deletes run records.
153
- */
154
- delete<ThrowOnError extends boolean = false>(parameters: {
155
- id: string;
156
- directory?: string;
157
- workspace?: string;
158
- }, options?: Options<never, ThrowOnError>): RequestResult<LoopDeleteResponses, LoopDeleteErrors, ThrowOnError>;
159
- /**
160
- * Get a loop
161
- *
162
- * Fetch a single loop definition by id, including its live runtime status.
163
- */
164
- get<ThrowOnError extends boolean = false>(parameters: {
165
- id: string;
166
- directory?: string;
167
- workspace?: string;
168
- }, options?: Options<never, ThrowOnError>): RequestResult<LoopGetResponses, LoopGetErrors, ThrowOnError>;
169
- /**
170
- * Update a loop
171
- *
172
- * Replace a loop definition. Re-arms its scheduler entry if trigger/enabled changed.
173
- */
174
- update<ThrowOnError extends boolean = false>(parameters: {
175
- path_id: string;
176
- directory?: string;
177
- workspace?: string;
178
- body_id: string;
179
- name: string;
180
- stages: Array<{
181
- name: string;
182
- agent: string;
183
- model?: string;
184
- objective: string;
185
- tokenBudget?: number;
186
- }>;
187
- trigger: {
188
- kind: "manual";
189
- } | {
190
- kind: "interval";
191
- everyMs: number;
192
- };
193
- maxRuns?: number;
194
- timeoutMs?: number;
195
- createPR?: boolean;
196
- sandbox?: boolean;
197
- worktree?: {
198
- name: string;
199
- branch?: string;
200
- directory: string;
201
- };
202
- paused?: boolean;
203
- enabled: boolean;
204
- createdAt: number;
205
- }, options?: Options<never, ThrowOnError>): RequestResult<LoopUpdateResponses, LoopUpdateErrors, ThrowOnError>;
206
- /**
207
- * Enable or disable a loop
208
- *
209
- * Set the loop's enabled flag. Disarmed timers are removed when disabling.
210
- */
211
- toggle<ThrowOnError extends boolean = false>(parameters: {
212
- id: string;
213
- directory?: string;
214
- workspace?: string;
215
- enabled: boolean;
216
- }, options?: Options<never, ThrowOnError>): RequestResult<LoopToggleResponses, LoopToggleErrors, ThrowOnError>;
217
- /**
218
- * Run a loop once
219
- *
220
- * Trigger an immediate run of the loop, ignoring its schedule.
221
- */
222
- run<ThrowOnError extends boolean = false>(parameters: {
223
- id: string;
224
- directory?: string;
225
- workspace?: string;
226
- }, options?: Options<never, ThrowOnError>): RequestResult<LoopRunResponses, LoopRunErrors, ThrowOnError>;
227
- /**
228
- * Abort in-flight loop run
229
- *
230
- * Cancel the currently running iteration of a loop without deleting its definition.
231
- */
232
- abort<ThrowOnError extends boolean = false>(parameters: {
233
- id: string;
234
- directory?: string;
235
- workspace?: string;
236
- }, options?: Options<never, ThrowOnError>): RequestResult<LoopAbortResponses, LoopAbortErrors, ThrowOnError>;
237
- /**
238
- * Pause a loop
239
- *
240
- * Set runtime status to paused; the scheduler entry is removed until resumed.
241
- */
242
- pause<ThrowOnError extends boolean = false>(parameters: {
243
- id: string;
244
- directory?: string;
245
- workspace?: string;
246
- }, options?: Options<never, ThrowOnError>): RequestResult<LoopPauseResponses, unknown, ThrowOnError>;
247
- /**
248
- * Resume a loop
249
- *
250
- * Clear the paused state and re-arm the scheduler entry if the loop has an interval trigger.
251
- */
252
- resume<ThrowOnError extends boolean = false>(parameters: {
253
- id: string;
254
- directory?: string;
255
- workspace?: string;
256
- }, options?: Options<never, ThrowOnError>): RequestResult<LoopResumeResponses, LoopResumeErrors, ThrowOnError>;
257
- /**
258
- * List a loop's runs
259
- *
260
- * Most-recent-first run history for a loop, capped server-side.
261
- */
262
- runs<ThrowOnError extends boolean = false>(parameters: {
263
- id: string;
264
- directory?: string;
265
- workspace?: string;
266
- limit?: number;
267
- }, options?: Options<never, ThrowOnError>): RequestResult<LoopRunsResponses, unknown, ThrowOnError>;
268
- /**
269
- * List recent loop runs across all loops
270
- *
271
- * Most-recent-first runs from every loop in the project, useful for a global activity view.
272
- */
273
- recentRuns<ThrowOnError extends boolean = false>(parameters?: {
274
- directory?: string;
275
- workspace?: string;
276
- limit?: number;
277
- }, options?: Options<never, ThrowOnError>): RequestResult<LoopRecentRunsResponses, unknown, ThrowOnError>;
278
- }
279
- export declare class Feature extends HeyApiClient {
280
- /**
281
- * Mutate a single feature (skip / mark-done / reset / add deps)
282
- *
283
- * Power-user lever: re-plan mid-flight by skipping a stuck feature, marking it done to advance, or resetting it to retry. Status transitions are coerced to the legal subset.
284
- */
285
- mutate<ThrowOnError extends boolean = false>(parameters: {
286
- id: string;
287
- featureID: string;
288
- directory?: string;
289
- workspace?: string;
290
- status?: "pending" | "running" | "done" | "blocked" | "skipped" | "error";
291
- error?: string;
292
- appendDependsOn?: Array<string>;
293
- }, options?: Options<never, ThrowOnError>): RequestResult<MissionFeatureMutateResponses, MissionFeatureMutateErrors, ThrowOnError>;
294
- }
295
- export declare class Mission extends HeyApiClient {
296
- /**
297
- * List missions
298
- *
299
- * List all missions defined for the current project, with live runtime status.
300
- */
301
- list<ThrowOnError extends boolean = false>(parameters?: {
302
- directory?: string;
303
- workspace?: string;
304
- }, options?: Options<never, ThrowOnError>): RequestResult<MissionListResponses, unknown, ThrowOnError>;
305
- /**
306
- * Create or update a mission
307
- *
308
- * Persist a mission definition. Generates the id, createdAt, and default status for new missions.
309
- */
310
- upsert<ThrowOnError extends boolean = false>(parameters: {
311
- directory?: string;
312
- workspace?: string;
313
- name: string;
314
- brief: string;
315
- milestones: Array<{
316
- id: string;
317
- name: string;
318
- features: Array<{
319
- id: string;
320
- name: string;
321
- objective: string;
322
- agent: string;
323
- model?: string;
324
- tokenBudget?: number;
325
- dependsOn?: Array<string>;
326
- status?: "pending" | "running" | "done" | "blocked" | "skipped" | "error";
327
- error?: string;
328
- }>;
329
- validation?: "scrutiny" | "user-test" | "none";
330
- status?: "pending" | "running" | "validating" | "done" | "blocked";
331
- }>;
332
- models?: {
333
- worker?: string;
334
- validation?: string;
335
- orchestrator?: string;
336
- };
337
- timeoutMs?: number;
338
- sandbox?: boolean;
339
- worktree?: {
340
- name: string;
341
- branch?: string;
342
- directory: string;
343
- };
344
- }, options?: Options<never, ThrowOnError>): RequestResult<MissionUpsertResponses, MissionUpsertErrors, ThrowOnError>;
345
- /**
346
- * List mission templates
347
- *
348
- * Built-in starter briefs the user can instantiate from the wizard.
349
- */
350
- templates<ThrowOnError extends boolean = false>(parameters?: {
351
- directory?: string;
352
- workspace?: string;
353
- }, options?: Options<never, ThrowOnError>): RequestResult<MissionTemplatesResponses, unknown, ThrowOnError>;
354
- /**
355
- * Generate a mission plan from a description
356
- *
357
- * Send a natural-language description to an AI and parse the response back into a fully-formed mission definition (brief + milestones + features). The response is a draft — the user still confirms before persistence.
358
- */
359
- generate<ThrowOnError extends boolean = false>(parameters: {
360
- directory?: string;
361
- workspace?: string;
362
- description: string;
363
- model?: string;
364
- agent?: string;
365
- }, options?: Options<never, ThrowOnError>): RequestResult<MissionGenerateResponses, MissionGenerateErrors, ThrowOnError>;
366
- /**
367
- * Delete a mission
368
- *
369
- * Remove a mission and its execution history. Cancels any in-flight orchestration first.
370
- */
371
- delete<ThrowOnError extends boolean = false>(parameters: {
372
- id: string;
373
- directory?: string;
374
- workspace?: string;
375
- }, options?: Options<never, ThrowOnError>): RequestResult<MissionDeleteResponses, MissionDeleteErrors, ThrowOnError>;
376
- /**
377
- * Get a mission
378
- *
379
- * Fetch a single mission definition by id, including its live runtime status.
380
- */
381
- get<ThrowOnError extends boolean = false>(parameters: {
382
- id: string;
383
- directory?: string;
384
- workspace?: string;
385
- }, options?: Options<never, ThrowOnError>): RequestResult<MissionGetResponses, MissionGetErrors, ThrowOnError>;
386
- /**
387
- * Update a mission
388
- *
389
- * Replace a mission definition. Status field is preserved unless the body changes it explicitly (so updates from the wizard don't accidentally restart orchestration).
390
- */
391
- update<ThrowOnError extends boolean = false>(parameters: {
392
- path_id: string;
393
- directory?: string;
394
- workspace?: string;
395
- body_id: string;
396
- name: string;
397
- brief: string;
398
- milestones: Array<{
399
- id: string;
400
- name: string;
401
- features: Array<{
402
- id: string;
403
- name: string;
404
- objective: string;
405
- agent: string;
406
- model?: string;
407
- tokenBudget?: number;
408
- dependsOn?: Array<string>;
409
- status?: "pending" | "running" | "done" | "blocked" | "skipped" | "error";
410
- error?: string;
411
- }>;
412
- validation?: "scrutiny" | "user-test" | "none";
413
- status?: "pending" | "running" | "validating" | "done" | "blocked";
414
- }>;
415
- models?: {
416
- worker?: string;
417
- validation?: string;
418
- orchestrator?: string;
419
- };
420
- timeoutMs?: number;
421
- sandbox?: boolean;
422
- worktree?: {
423
- name: string;
424
- branch?: string;
425
- directory: string;
426
- };
427
- status?: "planning" | "ready" | "running" | "paused" | "frozen" | "complete" | "error";
428
- createdAt: number;
429
- }, options?: Options<never, ThrowOnError>): RequestResult<MissionUpdateResponses, MissionUpdateErrors, ThrowOnError>;
430
- /**
431
- * Start (or resume) orchestration of a mission
432
- *
433
- * Drive the mission forward: pick the current milestone, run its ready features, validate, then advance. Resumes a paused or frozen mission; returns immediately if already in flight.
434
- */
435
- start<ThrowOnError extends boolean = false>(parameters: {
436
- id: string;
437
- directory?: string;
438
- workspace?: string;
439
- }, options?: Options<never, ThrowOnError>): RequestResult<MissionStartResponses, MissionStartErrors, ThrowOnError>;
440
- /**
441
- * Pause a mission
442
- *
443
- * Persist the paused flag and abort the current worker. Resume with /:id/start.
444
- */
445
- pause<ThrowOnError extends boolean = false>(parameters: {
446
- id: string;
447
- directory?: string;
448
- workspace?: string;
449
- }, options?: Options<never, ThrowOnError>): RequestResult<MissionPauseResponses, MissionPauseErrors, ThrowOnError>;
450
- /**
451
- * Cancel and freeze a mission
452
- *
453
- * Freeze the mission for reassessment. The orchestrator aborts, the persisted status becomes 'frozen', and the user can edit the plan before resuming.
454
- */
455
- cancel<ThrowOnError extends boolean = false>(parameters: {
456
- id: string;
457
- directory?: string;
458
- workspace?: string;
459
- }, options?: Options<never, ThrowOnError>): RequestResult<MissionCancelResponses, MissionCancelErrors, ThrowOnError>;
460
- /**
461
- * List a mission's execution history
462
- *
463
- * Most-recent-first feature/validation execution records for a mission, capped server-side.
464
- */
465
- execs<ThrowOnError extends boolean = false>(parameters: {
466
- id: string;
467
- directory?: string;
468
- workspace?: string;
469
- limit?: number;
470
- }, options?: Options<never, ThrowOnError>): RequestResult<MissionExecsResponses, unknown, ThrowOnError>;
471
- /**
472
- * List recent mission executions across all missions
473
- *
474
- * Most-recent-first execution records from every mission in the project.
475
- */
476
- recentExecs<ThrowOnError extends boolean = false>(parameters?: {
477
- directory?: string;
478
- workspace?: string;
479
- limit?: number;
480
- }, options?: Options<never, ThrowOnError>): RequestResult<MissionRecentExecsResponses, unknown, ThrowOnError>;
481
- private _feature?;
482
- get feature(): Feature;
483
- }
484
- export declare class Pty extends HeyApiClient {
485
- /**
486
- * List PTY sessions
487
- *
488
- * Get a list of all active pseudo-terminal (PTY) sessions managed by Nikcli.
489
- */
490
- list<ThrowOnError extends boolean = false>(parameters?: {
491
- directory?: string;
492
- workspace?: string;
493
- }, options?: Options<never, ThrowOnError>): RequestResult<PtyListResponses, unknown, ThrowOnError>;
494
- /**
495
- * Create PTY session
496
- *
497
- * Create a new pseudo-terminal (PTY) session for running shell commands and processes.
498
- */
499
- create<ThrowOnError extends boolean = false>(parameters?: {
500
- directory?: string;
501
- workspace?: string;
502
- command?: string;
503
- args?: Array<string>;
504
- cwd?: string;
505
- title?: string;
506
- env?: {
507
- [key: string]: string;
508
- };
509
- }, options?: Options<never, ThrowOnError>): RequestResult<PtyCreateResponses, PtyCreateErrors, ThrowOnError>;
510
- /**
511
- * Remove PTY session
512
- *
513
- * Remove and terminate a specific pseudo-terminal (PTY) session.
514
- */
515
- remove<ThrowOnError extends boolean = false>(parameters: {
516
- ptyID: string;
517
- directory?: string;
518
- workspace?: string;
519
- }, options?: Options<never, ThrowOnError>): RequestResult<PtyRemoveResponses, PtyRemoveErrors, ThrowOnError>;
520
- /**
521
- * Get PTY session
522
- *
523
- * Retrieve detailed information about a specific pseudo-terminal (PTY) session.
524
- */
525
- get<ThrowOnError extends boolean = false>(parameters: {
526
- ptyID: string;
527
- directory?: string;
528
- workspace?: string;
529
- }, options?: Options<never, ThrowOnError>): RequestResult<PtyGetResponses, PtyGetErrors, ThrowOnError>;
530
- /**
531
- * Update PTY session
532
- *
533
- * Update properties of an existing pseudo-terminal (PTY) session.
534
- */
535
- update<ThrowOnError extends boolean = false>(parameters: {
536
- ptyID: string;
537
- directory?: string;
538
- workspace?: string;
539
- title?: string;
540
- size?: {
541
- rows: number;
542
- cols: number;
543
- };
544
- }, options?: Options<never, ThrowOnError>): RequestResult<PtyUpdateResponses, PtyUpdateErrors, ThrowOnError>;
545
- /**
546
- * Connect to PTY session
547
- *
548
- * Establish a WebSocket connection to interact with a pseudo-terminal (PTY) session in real-time.
549
- */
550
- connect<ThrowOnError extends boolean = false>(parameters: {
551
- ptyID: string;
552
- directory?: string;
553
- workspace?: string;
554
- }, options?: Options<never, ThrowOnError>): RequestResult<PtyConnectResponses, PtyConnectErrors, ThrowOnError>;
555
- }
556
- export declare class Config extends HeyApiClient {
557
- /**
558
- * Get configuration
559
- *
560
- * Retrieve the current Nikcli configuration settings and preferences.
561
- */
562
- get<ThrowOnError extends boolean = false>(parameters?: {
563
- directory?: string;
564
- workspace?: string;
565
- }, options?: Options<never, ThrowOnError>): RequestResult<ConfigGetResponses, unknown, ThrowOnError>;
566
- /**
567
- * Update configuration
568
- *
569
- * Update Nikcli configuration settings and preferences.
570
- */
571
- update<ThrowOnError extends boolean = false>(parameters?: {
572
- directory?: string;
573
- workspace?: string;
574
- config?: Config3;
575
- }, options?: Options<never, ThrowOnError>): RequestResult<ConfigUpdateResponses, ConfigUpdateErrors, ThrowOnError>;
576
- /**
577
- * Reload configuration
578
- *
579
- * Hot-reload the instance: invalidate reloadable per-instance state so the next read reflects config files on disk. Emits instance.reload.started / instance.reloaded on the event stream.
580
- */
581
- reload<ThrowOnError extends boolean = false>(parameters?: {
582
- directory?: string;
583
- workspace?: string;
584
- }, options?: Options<never, ThrowOnError>): RequestResult<ConfigReloadResponses, unknown, ThrowOnError>;
585
- /**
586
- * List config providers
587
- *
588
- * Get a list of all configured AI providers and their default models.
589
- */
590
- providers<ThrowOnError extends boolean = false>(parameters?: {
591
- directory?: string;
592
- workspace?: string;
593
- }, options?: Options<never, ThrowOnError>): RequestResult<ConfigProvidersResponses, unknown, ThrowOnError>;
594
- }
595
- export declare class Tool extends HeyApiClient {
596
- /**
597
- * List tool IDs
598
- *
599
- * Get a list of all available tool IDs, including both built-in tools and dynamically registered tools.
600
- */
601
- ids<ThrowOnError extends boolean = false>(parameters?: {
602
- directory?: string;
603
- workspace?: string;
604
- }, options?: Options<never, ThrowOnError>): RequestResult<ToolIdsResponses, ToolIdsErrors, ThrowOnError>;
605
- /**
606
- * List tools
607
- *
608
- * Get a list of available tools with their JSON schema parameters for a specific provider and model combination.
609
- */
610
- list<ThrowOnError extends boolean = false>(parameters: {
611
- directory?: string;
612
- workspace?: string;
613
- provider: string;
614
- model: string;
615
- }, options?: Options<never, ThrowOnError>): RequestResult<ToolListResponses, ToolListErrors, ThrowOnError>;
616
- }
617
- export declare class Worktree extends HeyApiClient {
618
- /**
619
- * Remove worktree
620
- *
621
- * Remove a git worktree and delete its branch.
622
- */
623
- remove<ThrowOnError extends boolean = false>(parameters?: {
624
- directory?: string;
625
- workspace?: string;
626
- worktreeRemoveInput?: WorktreeRemoveInput;
627
- }, options?: Options<never, ThrowOnError>): RequestResult<WorktreeRemoveResponses, WorktreeRemoveErrors, ThrowOnError>;
628
- /**
629
- * List worktrees
630
- *
631
- * List all sandbox worktrees for the current project.
632
- */
633
- list<ThrowOnError extends boolean = false>(parameters?: {
634
- directory?: string;
635
- workspace?: string;
636
- }, options?: Options<never, ThrowOnError>): RequestResult<WorktreeListResponses, unknown, ThrowOnError>;
637
- /**
638
- * Create worktree
639
- *
640
- * Create a new git worktree for the current project.
641
- */
642
- create<ThrowOnError extends boolean = false>(parameters?: {
643
- directory?: string;
644
- workspace?: string;
645
- worktreeCreateInput?: WorktreeCreateInput;
646
- }, options?: Options<never, ThrowOnError>): RequestResult<WorktreeCreateResponses, WorktreeCreateErrors, ThrowOnError>;
647
- /**
648
- * Reset worktree
649
- *
650
- * Reset a worktree branch to the primary default branch.
651
- */
652
- reset<ThrowOnError extends boolean = false>(parameters?: {
653
- directory?: string;
654
- workspace?: string;
655
- worktreeResetInput?: WorktreeResetInput;
656
- }, options?: Options<never, ThrowOnError>): RequestResult<WorktreeResetResponses, WorktreeResetErrors, ThrowOnError>;
657
- }
658
- export declare class Adaptor extends HeyApiClient {
659
- /**
660
- * List workspace adaptors
661
- *
662
- * Get available workspace adaptor types for creating workspaces.
663
- */
664
- list<ThrowOnError extends boolean = false>(parameters?: {
665
- directory?: string;
666
- workspace?: string;
667
- }, options?: Options<never, ThrowOnError>): RequestResult<ExperimentalWorkspaceAdaptorListResponses, unknown, ThrowOnError>;
668
- }
669
- export declare class Session extends HeyApiClient {
670
- /**
671
- * Restore session into workspace
672
- *
673
- * Attach an existing session to a workspace and return restore state for the client.
674
- */
675
- restore<ThrowOnError extends boolean = false>(parameters: {
676
- id: string;
677
- sessionID: string;
678
- directory?: string;
679
- workspace?: string;
680
- timeoutMs?: number;
681
- }, options?: Options<never, ThrowOnError>): RequestResult<ExperimentalWorkspaceSessionRestoreResponses, ExperimentalWorkspaceSessionRestoreErrors, ThrowOnError>;
682
- /**
683
- * Warp session between workspaces
684
- *
685
- * Move a session to another workspace, or detach it back to the local project by passing workspaceID: null.
686
- */
687
- warp<ThrowOnError extends boolean = false>(parameters: {
688
- sessionID: string;
689
- directory?: string;
690
- workspace?: string;
691
- workspaceID: string | null;
692
- copyChanges?: boolean;
693
- timeoutMs?: number;
694
- }, options?: Options<never, ThrowOnError>): RequestResult<ExperimentalWorkspaceSessionWarpResponses, ExperimentalWorkspaceSessionWarpErrors, ThrowOnError>;
695
- }
696
- export declare class Workspace extends HeyApiClient {
697
- /**
698
- * Warp session into workspace
699
- *
700
- * Move a session to a target workspace, or detach it back to the local project.
701
- */
702
- warp<ThrowOnError extends boolean = false>(parameters: {
703
- directory?: string;
704
- workspace?: string;
705
- id: string | null;
706
- sessionID: string;
707
- copyChanges?: boolean;
708
- timeoutMs?: number;
709
- }, options?: Options<never, ThrowOnError>): RequestResult<ExperimentalWorkspaceWarpResponses, ExperimentalWorkspaceWarpErrors, ThrowOnError>;
710
- /**
711
- * Sync workspace list
712
- *
713
- * Register missing workspaces returned by workspace adaptors.
714
- */
715
- syncList<ThrowOnError extends boolean = false>(parameters?: {
716
- directory?: string;
717
- workspace?: string;
718
- }, options?: Options<never, ThrowOnError>): RequestResult<ExperimentalWorkspaceSyncListResponses, unknown, ThrowOnError>;
719
- /**
720
- * Workspace status
721
- *
722
- * Get connection status for workspaces in the current project.
723
- */
724
- status<ThrowOnError extends boolean = false>(parameters?: {
725
- directory?: string;
726
- workspace?: string;
727
- }, options?: Options<never, ThrowOnError>): RequestResult<ExperimentalWorkspaceStatusResponses, unknown, ThrowOnError>;
728
- /**
729
- * Remove workspace
730
- *
731
- * Remove an existing workspace.
732
- */
733
- remove<ThrowOnError extends boolean = false>(parameters: {
734
- id: string;
735
- directory?: string;
736
- workspace?: string;
737
- }, options?: Options<never, ThrowOnError>): RequestResult<ExperimentalWorkspaceRemoveResponses, ExperimentalWorkspaceRemoveErrors, ThrowOnError>;
738
- /**
739
- * Create workspace
740
- *
741
- * Create a workspace for the current project.
742
- */
743
- create<ThrowOnError extends boolean = false>(parameters: {
744
- id: string;
745
- directory?: string;
746
- workspace?: string;
747
- branch: string | null;
748
- config: {
749
- directory: string;
750
- type: "worktree";
751
- name?: string;
752
- strategy?: "git" | "cow";
753
- eventLimit?: number;
754
- } | {
755
- directory: string;
756
- type: "container";
757
- runtime: "docker" | "podman";
758
- image: string;
759
- containerName: string;
760
- port: number;
761
- serverUrl: string;
762
- eventLimit?: number;
763
- } | {
764
- directory: string;
765
- type: "branch";
766
- branch?: string;
767
- eventLimit?: number;
768
- };
769
- }, options?: Options<never, ThrowOnError>): RequestResult<ExperimentalWorkspaceCreateResponses, ExperimentalWorkspaceCreateErrors, ThrowOnError>;
770
- /**
771
- * Workspace event journal
772
- *
773
- * Sequenced restore events for a workspace. Pass `from` (last seen sequence number) to catch up incrementally after a disconnect.
774
- */
775
- events<ThrowOnError extends boolean = false>(parameters: {
776
- id: string;
777
- directory?: string;
778
- workspace?: string;
779
- from?: number;
780
- }, options?: Options<never, ThrowOnError>): RequestResult<ExperimentalWorkspaceEventsResponses, ExperimentalWorkspaceEventsErrors, ThrowOnError>;
781
- /**
782
- * Restore workspace
783
- *
784
- * Ensure a workspace is connected and return enough state to restore the client UI.
785
- */
786
- restore<ThrowOnError extends boolean = false>(parameters: {
787
- id: string;
788
- directory?: string;
789
- workspace?: string;
790
- timeoutMs?: number;
791
- }, options?: Options<never, ThrowOnError>): RequestResult<ExperimentalWorkspaceRestoreResponses, ExperimentalWorkspaceRestoreErrors, ThrowOnError>;
792
- /**
793
- * List workspaces
794
- *
795
- * List all workspaces.
796
- */
797
- list<ThrowOnError extends boolean = false>(parameters?: {
798
- directory?: string;
799
- workspace?: string;
800
- }, options?: Options<never, ThrowOnError>): RequestResult<ExperimentalWorkspaceListResponses, unknown, ThrowOnError>;
801
- private _adaptor?;
802
- get adaptor(): Adaptor;
803
- private _session?;
804
- get session(): Session;
805
- }
806
- export declare class Resource extends HeyApiClient {
807
- /**
808
- * Get MCP resources
809
- *
810
- * Get all available MCP resources from connected servers. Optionally filter by name.
811
- */
812
- list<ThrowOnError extends boolean = false>(parameters?: {
813
- directory?: string;
814
- workspace?: string;
815
- }, options?: Options<never, ThrowOnError>): RequestResult<ExperimentalResourceListResponses, unknown, ThrowOnError>;
816
- }
817
- export declare class Experimental extends HeyApiClient {
818
- private _workspace?;
819
- get workspace(): Workspace;
820
- private _resource?;
821
- get resource(): Resource;
822
- }
823
- export declare class ManagedWorktree extends HeyApiClient {
824
- /**
825
- * Remove managed worktree
826
- *
827
- * Remove a managed worktree and its descendant subtree.
828
- */
829
- remove<ThrowOnError extends boolean = false>(parameters?: {
830
- directory?: string;
831
- workspace?: string;
832
- managedWorktreeRemoveInput?: ManagedWorktreeRemoveInput;
833
- }, options?: Options<never, ThrowOnError>): RequestResult<ManagedWorktreeRemoveResponses, ManagedWorktreeRemoveErrors, ThrowOnError>;
834
- /**
835
- * List all managed worktrees
836
- *
837
- * Get all registered managed worktrees.
838
- */
839
- list<ThrowOnError extends boolean = false>(parameters?: {
840
- directory?: string;
841
- workspace?: string;
842
- }, options?: Options<never, ThrowOnError>): RequestResult<ManagedWorktreeListResponses, ManagedWorktreeListErrors, ThrowOnError>;
843
- /**
844
- * Create managed worktree
845
- *
846
- * Clone a workspace with copy-on-write support.
847
- */
848
- create<ThrowOnError extends boolean = false>(parameters?: {
849
- directory?: string;
850
- workspace?: string;
851
- managedWorktreeCreateInput?: ManagedWorktreeCreateInput;
852
- }, options?: Options<never, ThrowOnError>): RequestResult<ManagedWorktreeCreateResponses, ManagedWorktreeCreateErrors, ThrowOnError>;
853
- /**
854
- * Link managed worktree
855
- *
856
- * Reconnect a moved managed worktree to its registry record.
857
- */
858
- link<ThrowOnError extends boolean = false>(parameters?: {
859
- directory?: string;
860
- workspace?: string;
861
- managedWorktreeLinkInput?: ManagedWorktreeLinkInput;
862
- }, options?: Options<never, ThrowOnError>): RequestResult<ManagedWorktreeLinkResponses, ManagedWorktreeLinkErrors, ThrowOnError>;
863
- /**
864
- * List managed worktree children
865
- *
866
- * Get direct managed children of a worktree.
867
- */
868
- children<ThrowOnError extends boolean = false>(parameters: {
869
- directory?: string;
870
- workspace?: string;
871
- of: string;
872
- }, options?: Options<never, ThrowOnError>): RequestResult<ManagedWorktreeChildrenResponses, ManagedWorktreeChildrenErrors, ThrowOnError>;
873
- /**
874
- * List managed worktree ancestors
875
- *
876
- * Get the managed ancestry of a worktree.
877
- */
878
- ancestors<ThrowOnError extends boolean = false>(parameters: {
879
- directory?: string;
880
- workspace?: string;
881
- of: string;
882
- }, options?: Options<never, ThrowOnError>): RequestResult<ManagedWorktreeAncestorsResponses, ManagedWorktreeAncestorsErrors, ThrowOnError>;
883
- }
884
- export declare class Background extends HeyApiClient {
885
- /**
886
- * Inspect background job
887
- *
888
- * Inspect a durable background job from a related session.
889
- */
890
- inspect<ThrowOnError extends boolean = false>(parameters: {
891
- sessionID: string;
892
- delegationID: string;
893
- directory?: string;
894
- workspace?: string;
895
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionBackgroundInspectResponses, SessionBackgroundInspectErrors, ThrowOnError>;
896
- /**
897
- * Read background job output
898
- *
899
- * Read the synthesized output for a durable background job.
900
- */
901
- read<ThrowOnError extends boolean = false>(parameters: {
902
- sessionID: string;
903
- delegationID: string;
904
- directory?: string;
905
- workspace?: string;
906
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionBackgroundReadResponses, SessionBackgroundReadErrors, ThrowOnError>;
907
- /**
908
- * Cancel background job
909
- *
910
- * Cancel a durable background job from a related session.
911
- */
912
- cancel<ThrowOnError extends boolean = false>(parameters: {
913
- sessionID: string;
914
- delegationID: string;
915
- directory?: string;
916
- workspace?: string;
917
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionBackgroundCancelResponses, SessionBackgroundCancelErrors, ThrowOnError>;
918
- }
919
- export declare class V2 extends HeyApiClient {
920
- /**
921
- * Get session v2 entries
922
- *
923
- * Retrieve the session as v2 entries: committed messages converted from storage plus the live in-flight assistant tail. Experimental — the v2 read model is documented in specs/v2/message-shape.md.
924
- */
925
- entries<ThrowOnError extends boolean = false>(parameters: {
926
- sessionID: string;
927
- directory?: string;
928
- workspace?: string;
929
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionV2EntriesResponses, SessionV2EntriesErrors, ThrowOnError>;
930
- /**
931
- * Get live session v2 state
932
- *
933
- * Retrieve the live v2 state for a session: `pending` holds the in-flight assistant work reduced by the v2 stepper. Entry-grade changes are announced on the bus as `session.v2.updated`. Experimental.
934
- */
935
- state<ThrowOnError extends boolean = false>(parameters: {
936
- sessionID: string;
937
- directory?: string;
938
- workspace?: string;
939
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionV2StateResponses, SessionV2StateErrors, ThrowOnError>;
940
- /**
941
- * Get the persisted session v2 event log
942
- *
943
- * Retrieve the durable v2 event log for a session in replay order: step lifecycle events plus per-part coalesced updates. Replaying it through the v2 stepper reproduces the session reduction. Experimental.
944
- */
945
- events<ThrowOnError extends boolean = false>(parameters: {
946
- sessionID: string;
947
- directory?: string;
948
- workspace?: string;
949
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionV2EventsResponses, SessionV2EventsErrors, ThrowOnError>;
950
- }
951
- export declare class Session2 extends HeyApiClient {
952
- /**
953
- * List sessions
954
- *
955
- * Get a list of all Nikcli sessions, sorted by most recently updated.
956
- */
957
- list<ThrowOnError extends boolean = false>(parameters?: {
958
- directory?: string;
959
- workspace?: string;
960
- roots?: boolean;
961
- start?: number;
962
- search?: string;
963
- limit?: number;
964
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionListResponses, unknown, ThrowOnError>;
965
- /**
966
- * Create session
967
- *
968
- * Create a new Nikcli session for interacting with AI assistants and managing conversations.
969
- */
970
- create<ThrowOnError extends boolean = false>(parameters?: {
971
- directory?: string;
972
- workspace?: string;
973
- parentID?: string;
974
- title?: string;
975
- permission?: PermissionRuleset;
976
- skills?: Array<string>;
977
- disabledInstructions?: Array<string>;
978
- disabledTools?: {
979
- [key: string]: boolean;
980
- };
981
- github?: SessionGithub;
982
- worktree?: SessionWorktree;
983
- workspaceID?: string;
984
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionCreateResponses, SessionCreateErrors, ThrowOnError>;
985
- /**
986
- * Get session status
987
- *
988
- * Retrieve the current status of all sessions, including active, idle, and completed states.
989
- */
990
- status<ThrowOnError extends boolean = false>(parameters?: {
991
- directory?: string;
992
- workspace?: string;
993
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionStatusResponses, SessionStatusErrors, ThrowOnError>;
994
- /**
995
- * Delete session
996
- *
997
- * Delete a session and permanently remove all associated data, including messages and history.
998
- */
999
- delete<ThrowOnError extends boolean = false>(parameters: {
1000
- sessionID: string;
1001
- directory?: string;
1002
- workspace?: string;
1003
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionDeleteResponses, SessionDeleteErrors, ThrowOnError>;
1004
- /**
1005
- * Get session
1006
- *
1007
- * Retrieve detailed information about a specific Nikcli session.
1008
- */
1009
- get<ThrowOnError extends boolean = false>(parameters: {
1010
- sessionID: string;
1011
- directory?: string;
1012
- workspace?: string;
1013
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionGetResponses, SessionGetErrors, ThrowOnError>;
1014
- /**
1015
- * Update session
1016
- *
1017
- * Update properties of an existing session, such as title or other metadata.
1018
- */
1019
- update<ThrowOnError extends boolean = false>(parameters: {
1020
- sessionID: string;
1021
- directory?: string;
1022
- workspace?: string;
1023
- title?: string;
1024
- time?: {
1025
- archived?: number;
1026
- };
1027
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionUpdateResponses, SessionUpdateErrors, ThrowOnError>;
1028
- /**
1029
- * Get loaded instruction files
1030
- *
1031
- * Retrieve the list of instruction files that are currently loaded for this session (AGENTS.md, CLAUDE.md, etc.)
1032
- */
1033
- instructions<ThrowOnError extends boolean = false>(parameters: {
1034
- sessionID: string;
1035
- directory?: string;
1036
- workspace?: string;
1037
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionInstructionsResponses, SessionInstructionsErrors, ThrowOnError>;
1038
- /**
1039
- * Get context usage breakdown
1040
- *
1041
- * Compute a per-source breakdown of estimated context tokens (system prompt, environment, instruction files, skills, MCP servers, built-in tools, agents, and conversation) along with the tokens last reported by the provider. Sources tagged togglable can be enabled/disabled to manage context.
1042
- */
1043
- context<ThrowOnError extends boolean = false>(parameters: {
1044
- sessionID: string;
1045
- directory?: string;
1046
- workspace?: string;
1047
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionContextResponses, SessionContextErrors, ThrowOnError>;
1048
- /**
1049
- * Enable or disable a context source
1050
- *
1051
- * Enable or disable a single context source for this session. Supports MCP servers (kind=mcp), active skills (kind=skill), instruction files (kind=instruction), and tools (kind=tool). Returns the recomputed context breakdown.
1052
- */
1053
- contextToggle<ThrowOnError extends boolean = false>(parameters: {
1054
- sessionID: string;
1055
- directory?: string;
1056
- workspace?: string;
1057
- kind: "mcp" | "skill" | "instruction" | "tool";
1058
- key: string;
1059
- enabled: boolean;
1060
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionContextToggleResponses, SessionContextToggleErrors, ThrowOnError>;
1061
- /**
1062
- * Get session children
1063
- *
1064
- * Retrieve all child sessions that were forked from the specified parent session.
1065
- */
1066
- children<ThrowOnError extends boolean = false>(parameters: {
1067
- sessionID: string;
1068
- directory?: string;
1069
- workspace?: string;
1070
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionChildrenResponses, SessionChildrenErrors, ThrowOnError>;
1071
- /**
1072
- * Get session todos
1073
- *
1074
- * Retrieve the todo list associated with a specific session, showing tasks and action items.
1075
- */
1076
- todo<ThrowOnError extends boolean = false>(parameters: {
1077
- sessionID: string;
1078
- directory?: string;
1079
- workspace?: string;
1080
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionTodoResponses, SessionTodoErrors, ThrowOnError>;
1081
- /**
1082
- * Get session goal
1083
- *
1084
- * Retrieve the active goal state for a session, or null when no goal is set.
1085
- */
1086
- goal<ThrowOnError extends boolean = false>(parameters: {
1087
- sessionID: string;
1088
- directory?: string;
1089
- workspace?: string;
1090
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionGoalResponses, SessionGoalErrors, ThrowOnError>;
1091
- /**
1092
- * Fork session
1093
- *
1094
- * Create a new session by forking an existing session at a specific message point.
1095
- */
1096
- fork<ThrowOnError extends boolean = false>(parameters: {
1097
- sessionID: string;
1098
- directory?: string;
1099
- workspace?: string;
1100
- messageID?: string;
1101
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionForkResponses, unknown, ThrowOnError>;
1102
- /**
1103
- * List background jobs
1104
- *
1105
- * List durable background jobs for a parent session.
1106
- */
1107
- background<ThrowOnError extends boolean = false>(parameters: {
1108
- sessionID: string;
1109
- directory?: string;
1110
- workspace?: string;
1111
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionBackgroundResponses, SessionBackgroundErrors, ThrowOnError>;
1112
- /**
1113
- * Abort session
1114
- *
1115
- * Abort an active session and stop any ongoing AI processing or command execution.
1116
- */
1117
- abort<ThrowOnError extends boolean = false>(parameters: {
1118
- sessionID: string;
1119
- directory?: string;
1120
- workspace?: string;
1121
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionAbortResponses, SessionAbortErrors, ThrowOnError>;
1122
- /**
1123
- * Unshare session
1124
- *
1125
- * Remove the shareable link for a session, making it private again.
1126
- */
1127
- unshare<ThrowOnError extends boolean = false>(parameters: {
1128
- sessionID: string;
1129
- directory?: string;
1130
- workspace?: string;
1131
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionUnshareResponses, SessionUnshareErrors, ThrowOnError>;
1132
- /**
1133
- * Share session
1134
- *
1135
- * Create a shareable link for a session, allowing others to view the conversation.
1136
- */
1137
- share<ThrowOnError extends boolean = false>(parameters: {
1138
- sessionID: string;
1139
- directory?: string;
1140
- workspace?: string;
1141
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionShareResponses, SessionShareErrors, ThrowOnError>;
1142
- /**
1143
- * Get message diff
1144
- *
1145
- * Get the file changes (diff) that resulted from a specific user message in the session.
1146
- */
1147
- diff<ThrowOnError extends boolean = false>(parameters: {
1148
- sessionID: string;
1149
- directory?: string;
1150
- workspace?: string;
1151
- messageID?: string;
1152
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionDiffResponses, unknown, ThrowOnError>;
1153
- /**
1154
- * Summarize session
1155
- *
1156
- * Generate a concise summary of the session using AI compaction to preserve key information.
1157
- */
1158
- summarize<ThrowOnError extends boolean = false>(parameters: {
1159
- sessionID: string;
1160
- directory?: string;
1161
- workspace?: string;
1162
- providerID: string;
1163
- modelID: string;
1164
- auto?: boolean;
1165
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionSummarizeResponses, SessionSummarizeErrors, ThrowOnError>;
1166
- /**
1167
- * Get session messages
1168
- *
1169
- * Retrieve all messages in a session, including user prompts and AI responses.
1170
- */
1171
- messages<ThrowOnError extends boolean = false>(parameters: {
1172
- sessionID: string;
1173
- directory?: string;
1174
- workspace?: string;
1175
- limit?: number;
1176
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionMessagesResponses, SessionMessagesErrors, ThrowOnError>;
1177
- /**
1178
- * Send message
1179
- *
1180
- * Create and send a new message to a session, streaming the AI response.
1181
- */
1182
- prompt<ThrowOnError extends boolean = false>(parameters: {
1183
- sessionID: string;
1184
- directory?: string;
1185
- workspace?: string;
1186
- messageID?: string;
1187
- model?: {
1188
- providerID: string;
1189
- modelID: string;
1190
- };
1191
- agent?: string;
1192
- noReply?: boolean;
1193
- tools?: {
1194
- [key: string]: boolean;
1195
- };
1196
- format?: OutputFormat;
1197
- system?: string;
1198
- variant?: string;
1199
- parts: Array<TextPartInput | FilePartInput | AgentPartInput | SubtaskPartInput>;
1200
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionPromptResponses, SessionPromptErrors, ThrowOnError>;
1201
- /**
1202
- * Get message
1203
- *
1204
- * Retrieve a specific message from a session by its message ID.
1205
- */
1206
- message<ThrowOnError extends boolean = false>(parameters: {
1207
- sessionID: string;
1208
- messageID: string;
1209
- directory?: string;
1210
- workspace?: string;
1211
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionMessageResponses, SessionMessageErrors, ThrowOnError>;
1212
- /**
1213
- * Send async message
1214
- *
1215
- * Create and send a new message to a session asynchronously. Persists the user message before returning 204, then runs the model loop in the background.
1216
- */
1217
- promptAsync<ThrowOnError extends boolean = false>(parameters: {
1218
- sessionID: string;
1219
- directory?: string;
1220
- workspace?: string;
1221
- messageID?: string;
1222
- model?: {
1223
- providerID: string;
1224
- modelID: string;
1225
- };
1226
- agent?: string;
1227
- noReply?: boolean;
1228
- tools?: {
1229
- [key: string]: boolean;
1230
- };
1231
- format?: OutputFormat;
1232
- system?: string;
1233
- variant?: string;
1234
- parts: Array<TextPartInput | FilePartInput | AgentPartInput | SubtaskPartInput>;
1235
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionPromptAsyncResponses, SessionPromptAsyncErrors, ThrowOnError>;
1236
- /**
1237
- * Send command
1238
- *
1239
- * Send a new command to a session for execution by the AI assistant.
1240
- */
1241
- command<ThrowOnError extends boolean = false>(parameters: {
1242
- sessionID: string;
1243
- directory?: string;
1244
- workspace?: string;
1245
- messageID?: string;
1246
- agent?: string;
1247
- model?: string;
1248
- command: string;
1249
- arguments: string;
1250
- variant?: string;
1251
- parts?: Array<TextPartInput | FilePartInput | AgentPartInput | SubtaskPartInput>;
1252
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionCommandResponses, SessionCommandErrors, ThrowOnError>;
1253
- /**
1254
- * Run shell command
1255
- *
1256
- * Execute a shell command within the session context and return the AI's response.
1257
- */
1258
- shell<ThrowOnError extends boolean = false>(parameters: {
1259
- sessionID: string;
1260
- directory?: string;
1261
- workspace?: string;
1262
- agent: string;
1263
- model?: {
1264
- providerID: string;
1265
- modelID: string;
1266
- };
1267
- command: string;
1268
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionShellResponses, SessionShellErrors, ThrowOnError>;
1269
- /**
1270
- * Revert message
1271
- *
1272
- * Revert a specific message in a session, undoing its effects and restoring the previous state.
1273
- */
1274
- revert<ThrowOnError extends boolean = false>(parameters: {
1275
- sessionID: string;
1276
- directory?: string;
1277
- workspace?: string;
1278
- messageID: string;
1279
- partID?: string;
1280
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionRevertResponses, SessionRevertErrors, ThrowOnError>;
1281
- /**
1282
- * Restore reverted messages
1283
- *
1284
- * Restore all previously reverted messages in a session.
1285
- */
1286
- unrevert<ThrowOnError extends boolean = false>(parameters: {
1287
- sessionID: string;
1288
- directory?: string;
1289
- workspace?: string;
1290
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionUnrevertResponses, SessionUnrevertErrors, ThrowOnError>;
1291
- /**
1292
- * Get session monitor
1293
- *
1294
- * Retrieve metadata for one background monitor attached to a session.
1295
- */
1296
- monitor<ThrowOnError extends boolean = false>(parameters: {
1297
- sessionID: string;
1298
- monitorID: string;
1299
- directory?: string;
1300
- workspace?: string;
1301
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionMonitorResponses, SessionMonitorErrors, ThrowOnError>;
1302
- /**
1303
- * Get session monitor log
1304
- *
1305
- * Read the latest output captured for a monitored background command.
1306
- */
1307
- monitorLog<ThrowOnError extends boolean = false>(parameters: {
1308
- sessionID: string;
1309
- monitorID: string;
1310
- directory?: string;
1311
- workspace?: string;
1312
- lines?: number;
1313
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionMonitorLogResponses, SessionMonitorLogErrors, ThrowOnError>;
1314
- /**
1315
- * Cancel session monitor
1316
- *
1317
- * Stop a monitored background command attached to a session.
1318
- */
1319
- monitorCancel<ThrowOnError extends boolean = false>(parameters: {
1320
- sessionID: string;
1321
- monitorID: string;
1322
- directory?: string;
1323
- workspace?: string;
1324
- }, options?: Options<never, ThrowOnError>): RequestResult<SessionMonitorCancelResponses, SessionMonitorCancelErrors, ThrowOnError>;
1325
- private _background?;
1326
- get background2(): Background;
1327
- private _v2?;
1328
- get v2(): V2;
1329
- }
1330
- export declare class Part extends HeyApiClient {
1331
- /**
1332
- * Delete a part from a message
1333
- */
1334
- delete<ThrowOnError extends boolean = false>(parameters: {
1335
- sessionID: string;
1336
- messageID: string;
1337
- partID: string;
1338
- directory?: string;
1339
- workspace?: string;
1340
- }, options?: Options<never, ThrowOnError>): RequestResult<PartDeleteResponses, PartDeleteErrors, ThrowOnError>;
1341
- /**
1342
- * Update a part in a message
1343
- */
1344
- update<ThrowOnError extends boolean = false>(parameters: {
1345
- sessionID: string;
1346
- messageID: string;
1347
- partID: string;
1348
- directory?: string;
1349
- workspace?: string;
1350
- part?: Part2;
1351
- }, options?: Options<never, ThrowOnError>): RequestResult<PartUpdateResponses, PartUpdateErrors, ThrowOnError>;
1352
- }
1353
- export declare class Permission extends HeyApiClient {
1354
- /**
1355
- * Respond to permission
1356
- *
1357
- * Approve or deny a permission request from the AI assistant.
1358
- *
1359
- * @deprecated
1360
- */
1361
- respond<ThrowOnError extends boolean = false>(parameters: {
1362
- sessionID: string;
1363
- permissionID: string;
1364
- directory?: string;
1365
- workspace?: string;
1366
- response: "once" | "always" | "reject";
1367
- }, options?: Options<never, ThrowOnError>): RequestResult<PermissionRespondResponses, PermissionRespondErrors, ThrowOnError>;
1368
- /**
1369
- * Respond to permission request
1370
- *
1371
- * Approve or deny a permission request from the AI assistant.
1372
- */
1373
- reply<ThrowOnError extends boolean = false>(parameters: {
1374
- requestID: string;
1375
- directory?: string;
1376
- workspace?: string;
1377
- reply: "once" | "always" | "reject";
1378
- message?: string;
1379
- }, options?: Options<never, ThrowOnError>): RequestResult<PermissionReplyResponses, PermissionReplyErrors, ThrowOnError>;
1380
- /**
1381
- * List pending permissions
1382
- *
1383
- * Get all pending permission requests across all sessions.
1384
- */
1385
- list<ThrowOnError extends boolean = false>(parameters?: {
1386
- directory?: string;
1387
- workspace?: string;
1388
- }, options?: Options<never, ThrowOnError>): RequestResult<PermissionListResponses, unknown, ThrowOnError>;
1389
- }
1390
- export declare class Event_ extends HeyApiClient {
1391
- /**
1392
- * Push a sync event from a remote CLI
1393
- */
1394
- push<ThrowOnError extends boolean = false>(parameters: {
1395
- directory?: string;
1396
- workspace?: string;
1397
- event: {
1398
- id: string;
1399
- projectId: string;
1400
- workspaceId?: string;
1401
- aggregate: string;
1402
- seq: number;
1403
- type: string;
1404
- data: unknown;
1405
- timestamp: number;
1406
- origin?: string;
1407
- originSeq?: number;
1408
- };
1409
- projectID: string;
1410
- }, options?: Options<never, ThrowOnError>): RequestResult<SyncEventPushResponses, SyncEventPushErrors, ThrowOnError>;
1411
- /**
1412
- * SSE stream of new sync events
1413
- */
1414
- stream<ThrowOnError extends boolean = false>(parameters: {
1415
- directory?: string;
1416
- workspace?: string;
1417
- projectID: string;
1418
- token: string;
1419
- }, options?: Options<never, ThrowOnError>): RequestResult<SyncEventStreamResponses, unknown, ThrowOnError>;
1420
- }
1421
- export declare class Outbox extends HeyApiClient {
1422
- /**
1423
- * List events since a given sequence for catch-up
1424
- */
1425
- list<ThrowOnError extends boolean = false>(parameters: {
1426
- directory?: string;
1427
- workspace?: string;
1428
- projectID: string;
1429
- since?: number;
1430
- }, options?: Options<never, ThrowOnError>): RequestResult<SyncOutboxListResponses, unknown, ThrowOnError>;
1431
- }
1432
- export declare class Snapshot extends HeyApiClient {
1433
- /**
1434
- * Cold-start projection snapshot for an aggregate
1435
- *
1436
- * Returns the snapshot-backed projected state and last sequence number for a workspace (wrk_…) or session (ses_…) aggregate, so a client can restore without replaying the full event log.
1437
- */
1438
- get<ThrowOnError extends boolean = false>(parameters: {
1439
- aggregateID: string;
1440
- directory?: string;
1441
- workspace?: string;
1442
- projectID: string;
1443
- }, options?: Options<never, ThrowOnError>): RequestResult<SyncSnapshotGetResponses, SyncSnapshotGetErrors, ThrowOnError>;
1444
- }
1445
- export declare class Config2 extends HeyApiClient {
1446
- /**
1447
- * Save the remote hub settings to the global config file
1448
- *
1449
- * Persists `sync.url` / `sync.token` in the global nikcli.json so the TUI can configure the hub without env vars. NIKCLI_REMOTE_URL / NIKCLI_REMOTE_TOKEN still override the saved values. When the result is fully configured, the hub connection is started immediately.
1450
- */
1451
- set<ThrowOnError extends boolean = false>(parameters: {
1452
- directory?: string;
1453
- workspace?: string;
1454
- url: string;
1455
- token?: string;
1456
- autostart?: boolean;
1457
- }, options?: Options<never, ThrowOnError>): RequestResult<SyncConfigSetResponses, SyncConfigSetErrors, ThrowOnError>;
1458
- }
1459
- export declare class Sync extends HeyApiClient {
1460
- /**
1461
- * Aggregated sync stats for the TUI
1462
- */
1463
- stats<ThrowOnError extends boolean = false>(parameters?: {
1464
- directory?: string;
1465
- workspace?: string;
1466
- projectID?: string;
1467
- }, options?: Options<never, ThrowOnError>): RequestResult<SyncStatsResponses, unknown, ThrowOnError>;
1468
- /**
1469
- * Force a connection to the configured hub
1470
- */
1471
- connect<ThrowOnError extends boolean = false>(parameters?: {
1472
- directory?: string;
1473
- workspace?: string;
1474
- }, options?: Options<never, ThrowOnError>): RequestResult<SyncConnectResponses, unknown, ThrowOnError>;
1475
- /**
1476
- * Abort the hub connection
1477
- */
1478
- disconnect<ThrowOnError extends boolean = false>(parameters?: {
1479
- directory?: string;
1480
- workspace?: string;
1481
- }, options?: Options<never, ThrowOnError>): RequestResult<SyncDisconnectResponses, unknown, ThrowOnError>;
1482
- /**
1483
- * Force an outbox drain now
1484
- */
1485
- drain<ThrowOnError extends boolean = false>(parameters?: {
1486
- directory?: string;
1487
- workspace?: string;
1488
- }, options?: Options<never, ThrowOnError>): RequestResult<SyncDrainResponses, unknown, ThrowOnError>;
1489
- private _event?;
1490
- get event(): Event_;
1491
- private _outbox?;
1492
- get outbox(): Outbox;
1493
- private _snapshot?;
1494
- get snapshot(): Snapshot;
1495
- private _config?;
1496
- get config(): Config2;
1497
- }
1498
- export declare class Question extends HeyApiClient {
1499
- /**
1500
- * List pending questions
1501
- *
1502
- * Get all pending question requests across all sessions.
1503
- */
1504
- list<ThrowOnError extends boolean = false>(parameters?: {
1505
- directory?: string;
1506
- workspace?: string;
1507
- }, options?: Options<never, ThrowOnError>): RequestResult<QuestionListResponses, unknown, ThrowOnError>;
1508
- /**
1509
- * Reply to question request
1510
- *
1511
- * Provide answers to a question request from the AI assistant.
1512
- */
1513
- reply<ThrowOnError extends boolean = false>(parameters: {
1514
- requestID: string;
1515
- directory?: string;
1516
- workspace?: string;
1517
- answers: Array<QuestionAnswer>;
1518
- }, options?: Options<never, ThrowOnError>): RequestResult<QuestionReplyResponses, QuestionReplyErrors, ThrowOnError>;
1519
- /**
1520
- * Reject question request
1521
- *
1522
- * Reject a question request from the AI assistant.
1523
- */
1524
- reject<ThrowOnError extends boolean = false>(parameters: {
1525
- requestID: string;
1526
- directory?: string;
1527
- workspace?: string;
1528
- }, options?: Options<never, ThrowOnError>): RequestResult<QuestionRejectResponses, QuestionRejectErrors, ThrowOnError>;
1529
- }
1530
- export declare class Api extends HeyApiClient {
1531
- /**
1532
- * Set provider API key
1533
- *
1534
- * Store an API key for a provider and refresh the current instance cache.
1535
- */
1536
- set<ThrowOnError extends boolean = false>(parameters: {
1537
- providerID: string;
1538
- directory?: string;
1539
- workspace?: string;
1540
- key: string;
1541
- }, options?: Options<never, ThrowOnError>): RequestResult<ProviderApiSetResponses, ProviderApiSetErrors, ThrowOnError>;
1542
- }
1543
- export declare class Auth extends HeyApiClient {
1544
- /**
1545
- * Remove provider credentials
1546
- *
1547
- * Remove stored credentials for a provider and refresh the current instance cache.
1548
- */
1549
- remove<ThrowOnError extends boolean = false>(parameters: {
1550
- providerID: string;
1551
- directory?: string;
1552
- workspace?: string;
1553
- }, options?: Options<never, ThrowOnError>): RequestResult<ProviderAuthRemoveResponses, unknown, ThrowOnError>;
1554
- }
1555
- export declare class Oauth extends HeyApiClient {
1556
- /**
1557
- * OAuth authorize
1558
- *
1559
- * Initiate OAuth authorization for a specific AI provider to get an authorization URL.
1560
- */
1561
- authorize<ThrowOnError extends boolean = false>(parameters: {
1562
- providerID: string;
1563
- directory?: string;
1564
- workspace?: string;
1565
- method: number;
1566
- }, options?: Options<never, ThrowOnError>): RequestResult<ProviderOauthAuthorizeResponses, ProviderOauthAuthorizeErrors, ThrowOnError>;
1567
- /**
1568
- * OAuth callback
1569
- *
1570
- * Handle the OAuth callback from a provider after user authorization.
1571
- */
1572
- callback<ThrowOnError extends boolean = false>(parameters: {
1573
- providerID: string;
1574
- directory?: string;
1575
- workspace?: string;
1576
- method: number;
1577
- code?: string;
1578
- }, options?: Options<never, ThrowOnError>): RequestResult<ProviderOauthCallbackResponses, ProviderOauthCallbackErrors, ThrowOnError>;
1579
- }
1580
- export declare class Provider extends HeyApiClient {
1581
- /**
1582
- * List providers
1583
- *
1584
- * Get a list of all available AI providers, including both available and connected ones.
1585
- */
1586
- list<ThrowOnError extends boolean = false>(parameters?: {
1587
- directory?: string;
1588
- workspace?: string;
1589
- }, options?: Options<never, ThrowOnError>): RequestResult<ProviderListResponses, unknown, ThrowOnError>;
1590
- /**
1591
- * Get provider auth methods
1592
- *
1593
- * Retrieve available authentication methods for all AI providers.
1594
- */
1595
- auth<ThrowOnError extends boolean = false>(parameters?: {
1596
- directory?: string;
1597
- workspace?: string;
1598
- }, options?: Options<never, ThrowOnError>): RequestResult<ProviderAuthResponses, unknown, ThrowOnError>;
1599
- private _api?;
1600
- get api(): Api;
1601
- private _auth?;
1602
- get auth2(): Auth;
1603
- private _oauth?;
1604
- get oauth(): Oauth;
1605
- }
1606
- export declare class Token extends HeyApiClient {
1607
- /**
1608
- * List mobile auth tokens
1609
- *
1610
- * List all active mobile Bearer tokens.
1611
- */
1612
- list<ThrowOnError extends boolean = false>(parameters?: {
1613
- directory?: string;
1614
- workspace?: string;
1615
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileAuthTokenListResponses, unknown, ThrowOnError>;
1616
- /**
1617
- * Create mobile auth token
1618
- *
1619
- * Exchange valid Basic auth credentials for a long-lived mobile Bearer token.
1620
- */
1621
- create<ThrowOnError extends boolean = false>(parameters?: {
1622
- directory?: string;
1623
- workspace?: string;
1624
- name?: string;
1625
- expiresInDays?: number;
1626
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileAuthTokenCreateResponses, unknown, ThrowOnError>;
1627
- /**
1628
- * Revoke mobile auth token
1629
- *
1630
- * Revoke a previously issued mobile Bearer token.
1631
- */
1632
- revoke<ThrowOnError extends boolean = false>(parameters: {
1633
- id: string;
1634
- directory?: string;
1635
- workspace?: string;
1636
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileAuthTokenRevokeResponses, unknown, ThrowOnError>;
1637
- }
1638
- export declare class Auth2 extends HeyApiClient {
1639
- private _token?;
1640
- get token(): Token;
1641
- }
1642
- export declare class Command extends HeyApiClient {
1643
- /**
1644
- * List mobile commands
1645
- *
1646
- * Return command metadata safe for the mobile command palette and slash autocomplete.
1647
- */
1648
- list<ThrowOnError extends boolean = false>(parameters?: {
1649
- directory?: string;
1650
- workspace?: string;
1651
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileCommandListResponses, unknown, ThrowOnError>;
1652
- }
1653
- export declare class Project2 extends HeyApiClient {
1654
- /**
1655
- * List local projects for mobile
1656
- *
1657
- * Return local projects and sandboxes visible to the connected Nikcli host.
1658
- */
1659
- list<ThrowOnError extends boolean = false>(parameters?: {
1660
- directory?: string;
1661
- workspace?: string;
1662
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileProjectListResponses, unknown, ThrowOnError>;
1663
- }
1664
- export declare class Stash extends HeyApiClient {
1665
- /**
1666
- * List prompt stash for mobile
1667
- *
1668
- * Return reusable prompt snippets stored on the Nikcli host.
1669
- */
1670
- list<ThrowOnError extends boolean = false>(parameters?: {
1671
- directory?: string;
1672
- workspace?: string;
1673
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileMemoryStashListResponses, unknown, ThrowOnError>;
1674
- /**
1675
- * Create prompt stash entry
1676
- *
1677
- * Save a reusable prompt snippet on the Nikcli host.
1678
- */
1679
- create<ThrowOnError extends boolean = false>(parameters?: {
1680
- directory?: string;
1681
- workspace?: string;
1682
- mobilePromptStashCreateInput?: MobilePromptStashCreateInput;
1683
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileMemoryStashCreateResponses, MobileMemoryStashCreateErrors, ThrowOnError>;
1684
- /**
1685
- * Delete prompt stash entry
1686
- *
1687
- * Remove a reusable prompt snippet from the Nikcli host.
1688
- */
1689
- delete<ThrowOnError extends boolean = false>(parameters: {
1690
- id: string;
1691
- directory?: string;
1692
- workspace?: string;
1693
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileMemoryStashDeleteResponses, MobileMemoryStashDeleteErrors, ThrowOnError>;
1694
- }
1695
- export declare class Memory extends HeyApiClient {
1696
- /**
1697
- * List prompt history for mobile
1698
- *
1699
- * Return recent prompt history stored on the Nikcli host.
1700
- */
1701
- history<ThrowOnError extends boolean = false>(parameters?: {
1702
- directory?: string;
1703
- workspace?: string;
1704
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileMemoryHistoryResponses, unknown, ThrowOnError>;
1705
- /**
1706
- * Search prompt memories for mobile
1707
- *
1708
- * Search across stored session messages for memory-like prompt context from mobile.
1709
- */
1710
- search<ThrowOnError extends boolean = false>(parameters: {
1711
- directory?: string;
1712
- workspace?: string;
1713
- query: string;
1714
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileMemorySearchResponses, unknown, ThrowOnError>;
1715
- private _stash?;
1716
- get stash(): Stash;
1717
- }
1718
- export declare class ClientId extends HeyApiClient {
1719
- /**
1720
- * Persist GitHub OAuth client ID for mobile
1721
- *
1722
- * Save the GitHub OAuth client ID in the global host config so device sign-in remains available across projects and app restarts.
1723
- */
1724
- set<ThrowOnError extends boolean = false>(parameters: {
1725
- directory?: string;
1726
- workspace?: string;
1727
- clientId: string;
1728
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGithubOauthClientIdSetResponses, MobileGithubOauthClientIdSetErrors, ThrowOnError>;
1729
- }
1730
- export declare class Device extends HeyApiClient {
1731
- /**
1732
- * Start GitHub OAuth device flow
1733
- *
1734
- * Start a GitHub device authorization flow and return the verification code for mobile sign-in.
1735
- */
1736
- start<ThrowOnError extends boolean = false>(parameters?: {
1737
- directory?: string;
1738
- workspace?: string;
1739
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGithubOauthDeviceStartResponses, MobileGithubOauthDeviceStartErrors, ThrowOnError>;
1740
- /**
1741
- * Poll GitHub OAuth device flow
1742
- *
1743
- * Poll GitHub device authorization status and persist the approved token on the host.
1744
- */
1745
- poll<ThrowOnError extends boolean = false>(parameters?: {
1746
- directory?: string;
1747
- workspace?: string;
1748
- mobileGithubDeviceAuthPollInput?: MobileGithubDeviceAuthPollInput;
1749
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGithubOauthDevicePollResponses, MobileGithubOauthDevicePollErrors, ThrowOnError>;
1750
- }
1751
- export declare class Oauth2 extends HeyApiClient {
1752
- private _clientId?;
1753
- get clientId(): ClientId;
1754
- private _device?;
1755
- get device(): Device;
1756
- }
1757
- export declare class Auth3 extends HeyApiClient {
1758
- /**
1759
- * Remove stored GitHub token for mobile
1760
- *
1761
- * Delete the mobile GitHub token from the Nikcli host.
1762
- */
1763
- remove<ThrowOnError extends boolean = false>(parameters?: {
1764
- directory?: string;
1765
- workspace?: string;
1766
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGithubAuthRemoveResponses, unknown, ThrowOnError>;
1767
- /**
1768
- * Store GitHub token for mobile
1769
- *
1770
- * Persist a GitHub token on the Nikcli host for mobile repo access.
1771
- */
1772
- set<ThrowOnError extends boolean = false>(parameters: {
1773
- directory?: string;
1774
- workspace?: string;
1775
- token: string;
1776
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGithubAuthSetResponses, MobileGithubAuthSetErrors, ThrowOnError>;
1777
- }
1778
- export declare class Session3 extends HeyApiClient {
1779
- /**
1780
- * Create GitHub-backed mobile session
1781
- *
1782
- * Import a GitHub repo if needed, create an isolated worktree from a base branch, and start a session there.
1783
- */
1784
- create<ThrowOnError extends boolean = false>(parameters?: {
1785
- directory?: string;
1786
- workspace?: string;
1787
- mobileGithubSessionCreateInput?: MobileGithubSessionCreateInput;
1788
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGithubSessionCreateResponses, MobileGithubSessionCreateErrors, ThrowOnError>;
1789
- /**
1790
- * Publish GitHub session
1791
- *
1792
- * Commit the current worktree, push the session branch, and create or reuse a pull request.
1793
- */
1794
- publish<ThrowOnError extends boolean = false>(parameters: {
1795
- sessionID: string;
1796
- directory?: string;
1797
- workspace?: string;
1798
- mobileGithubPublishInput?: MobileGithubPublishInput;
1799
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGithubSessionPublishResponses, MobileGithubSessionPublishErrors, ThrowOnError>;
1800
- /**
1801
- * Cleanup session worktree
1802
- *
1803
- * Remove the isolated worktree created for a mobile session (GitHub-linked or plain).
1804
- */
1805
- cleanup<ThrowOnError extends boolean = false>(parameters: {
1806
- sessionID: string;
1807
- directory?: string;
1808
- workspace?: string;
1809
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGithubSessionCleanupResponses, MobileGithubSessionCleanupErrors, ThrowOnError>;
1810
- }
1811
- export declare class Github extends HeyApiClient {
1812
- /**
1813
- * List GitHub repositories for mobile
1814
- *
1815
- * List repositories available to the stored GitHub connector token.
1816
- */
1817
- repos<ThrowOnError extends boolean = false>(parameters?: {
1818
- directory?: string;
1819
- workspace?: string;
1820
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGithubReposResponses, unknown, ThrowOnError>;
1821
- /**
1822
- * List GitHub branches for mobile
1823
- *
1824
- * List branches for a GitHub repository available to the stored mobile GitHub token.
1825
- */
1826
- branches<ThrowOnError extends boolean = false>(parameters: {
1827
- owner: string;
1828
- repo: string;
1829
- directory?: string;
1830
- workspace?: string;
1831
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGithubBranchesResponses, unknown, ThrowOnError>;
1832
- /**
1833
- * List imported GitHub repos for mobile
1834
- *
1835
- * List GitHub repositories that have already been cloned into the Nikcli host cache.
1836
- */
1837
- imports<ThrowOnError extends boolean = false>(parameters?: {
1838
- directory?: string;
1839
- workspace?: string;
1840
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGithubImportsResponses, unknown, ThrowOnError>;
1841
- /**
1842
- * Import GitHub repo into Nikcli host
1843
- *
1844
- * Clone or refresh a repository from the connected GitHub account into the managed host cache.
1845
- */
1846
- import<ThrowOnError extends boolean = false>(parameters?: {
1847
- directory?: string;
1848
- workspace?: string;
1849
- mobileGithubImportRequest?: MobileGithubImportRequest;
1850
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGithubImportResponses, MobileGithubImportErrors, ThrowOnError>;
1851
- private _oauth?;
1852
- get oauth(): Oauth2;
1853
- private _auth?;
1854
- get auth(): Auth3;
1855
- private _session?;
1856
- get session(): Session3;
1857
- }
1858
- export declare class Command2 extends HeyApiClient {
1859
- /**
1860
- * List session commands for mobile
1861
- *
1862
- * Return command metadata resolved in the current session context for mobile slash autocomplete.
1863
- */
1864
- list<ThrowOnError extends boolean = false>(parameters: {
1865
- sessionID: string;
1866
- directory?: string;
1867
- workspace?: string;
1868
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileSessionCommandListResponses, MobileSessionCommandListErrors, ThrowOnError>;
1869
- }
1870
- export declare class Upload extends HeyApiClient {
1871
- /**
1872
- * Begin a teleport workspace upload
1873
- *
1874
- * Allocate a chunked upload slot for a working-directory tarball. Returns an uploadID.
1875
- */
1876
- begin<ThrowOnError extends boolean = false>(parameters?: {
1877
- directory?: string;
1878
- workspace?: string;
1879
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileSessionTeleportUploadBeginResponses, unknown, ThrowOnError>;
1880
- /**
1881
- * Append a teleport upload chunk
1882
- *
1883
- * Append raw bytes to a chunked working-directory upload.
1884
- */
1885
- chunk<ThrowOnError extends boolean = false>(parameters: {
1886
- uploadID: string;
1887
- directory?: string;
1888
- workspace?: string;
1889
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileSessionTeleportUploadChunkResponses, MobileSessionTeleportUploadChunkErrors, ThrowOnError>;
1890
- }
1891
- export declare class Teleport extends HeyApiClient {
1892
- /**
1893
- * Teleport a session from this server to another
1894
- *
1895
- * Archive the session's working directory and ship its transcript to a target server, so it can be resumed there. Used by the mobile app (which has no local filesystem).
1896
- */
1897
- out<ThrowOnError extends boolean = false>(parameters: {
1898
- sessionID: string;
1899
- directory?: string;
1900
- workspace?: string;
1901
- url: string;
1902
- token: string;
1903
- content?: boolean;
1904
- includeGit?: boolean;
1905
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileSessionTeleportOutResponses, MobileSessionTeleportOutErrors, ThrowOnError>;
1906
- private _upload?;
1907
- get upload(): Upload;
1908
- }
1909
- export declare class Session4 extends HeyApiClient {
1910
- /**
1911
- * List mobile sessions
1912
- *
1913
- * Return mobile-friendly session summaries with current status.
1914
- */
1915
- list<ThrowOnError extends boolean = false>(parameters?: {
1916
- directory?: string;
1917
- workspace?: string;
1918
- limit?: number;
1919
- search?: string;
1920
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileSessionListResponses, unknown, ThrowOnError>;
1921
- /**
1922
- * Create mobile session
1923
- *
1924
- * Create a new session for the mobile app.
1925
- */
1926
- create<ThrowOnError extends boolean = false>(parameters?: {
1927
- directory?: string;
1928
- workspace?: string;
1929
- mobileSessionCreateInput?: MobileSessionCreateInput;
1930
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileSessionCreateResponses, MobileSessionCreateErrors, ThrowOnError>;
1931
- /**
1932
- * Delete mobile session
1933
- *
1934
- * Permanently delete a session and all associated data.
1935
- */
1936
- delete<ThrowOnError extends boolean = false>(parameters: {
1937
- sessionID: string;
1938
- directory?: string;
1939
- workspace?: string;
1940
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileSessionDeleteResponses, MobileSessionDeleteErrors, ThrowOnError>;
1941
- /**
1942
- * Get mobile session detail
1943
- *
1944
- * Return a session, its messages, status, and pending permissions.
1945
- */
1946
- detail<ThrowOnError extends boolean = false>(parameters: {
1947
- sessionID: string;
1948
- directory?: string;
1949
- workspace?: string;
1950
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileSessionDetailResponses, MobileSessionDetailErrors, ThrowOnError>;
1951
- /**
1952
- * Get session diff for mobile
1953
- *
1954
- * Return file diffs for a specific message in a session.
1955
- */
1956
- diff<ThrowOnError extends boolean = false>(parameters: {
1957
- sessionID: string;
1958
- messageID: string;
1959
- directory?: string;
1960
- workspace?: string;
1961
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileSessionDiffResponses, unknown, ThrowOnError>;
1962
- /**
1963
- * Run mobile session command
1964
- *
1965
- * Execute a slash-style command against the current session.
1966
- */
1967
- command<ThrowOnError extends boolean = false>(parameters: {
1968
- sessionID: string;
1969
- directory?: string;
1970
- workspace?: string;
1971
- mobileSessionCommandInput?: MobileSessionCommandInput;
1972
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileSessionCommandResponses, MobileSessionCommandErrors, ThrowOnError>;
1973
- /**
1974
- * Send mobile session message
1975
- *
1976
- * Queue a message for a session and rely on the session stream for realtime updates.
1977
- */
1978
- message<ThrowOnError extends boolean = false>(parameters: {
1979
- sessionID: string;
1980
- directory?: string;
1981
- workspace?: string;
1982
- messageID?: string;
1983
- model?: {
1984
- providerID: string;
1985
- modelID: string;
1986
- };
1987
- agent?: string;
1988
- noReply?: boolean;
1989
- tools?: {
1990
- [key: string]: boolean;
1991
- };
1992
- format?: OutputFormat;
1993
- system?: string;
1994
- variant?: string;
1995
- parts: Array<TextPartInput | FilePartInput | AgentPartInput | SubtaskPartInput>;
1996
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileSessionMessageResponses, MobileSessionMessageErrors, ThrowOnError>;
1997
- /**
1998
- * Abort mobile session
1999
- *
2000
- * Abort the active run for a session.
2001
- */
2002
- abort<ThrowOnError extends boolean = false>(parameters: {
2003
- sessionID: string;
2004
- directory?: string;
2005
- workspace?: string;
2006
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileSessionAbortResponses, unknown, ThrowOnError>;
2007
- /**
2008
- * Stream mobile session events
2009
- *
2010
- * Subscribe to session-scoped realtime events for the mobile chat UI.
2011
- */
2012
- stream<ThrowOnError extends boolean = false>(parameters: {
2013
- sessionID: string;
2014
- directory?: string;
2015
- workspace?: string;
2016
- }, options?: Options<never, ThrowOnError, unknown>): Promise<ServerSentEventsResult<MobileSessionStreamResponses>>;
2017
- /**
2018
- * Rename a session
2019
- *
2020
- * Update the title of an existing session.
2021
- */
2022
- rename<ThrowOnError extends boolean = false>(parameters: {
2023
- sessionID: string;
2024
- directory?: string;
2025
- workspace?: string;
2026
- title: string;
2027
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileSessionRenameResponses, unknown, ThrowOnError>;
2028
- /**
2029
- * Teleport a session to this server
2030
- *
2031
- * Recreate a session transcript captured on another machine — optionally cloning its working directory via a previously uploaded `uploadID` — so it can be continued from the mobile app.
2032
- */
2033
- teleport<ThrowOnError extends boolean = false>(parameters: {
2034
- directory?: string;
2035
- workspace?: string;
2036
- title?: string;
2037
- name?: string;
2038
- origin?: string;
2039
- permission?: PermissionRuleset;
2040
- messages: Array<{
2041
- info: Message;
2042
- parts: Array<Part2>;
2043
- }>;
2044
- uploadID?: string;
2045
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileSessionTeleportResponses, MobileSessionTeleportErrors, ThrowOnError>;
2046
- private _command?;
2047
- get command2(): Command2;
2048
- private _teleport?;
2049
- get teleport2(): Teleport;
2050
- }
2051
- export declare class Permission2 extends HeyApiClient {
2052
- /**
2053
- * Respond to permission from mobile
2054
- *
2055
- * Approve, always approve, or reject a pending permission request.
2056
- */
2057
- respond<ThrowOnError extends boolean = false>(parameters: {
2058
- sessionID: string;
2059
- permissionID: string;
2060
- directory?: string;
2061
- workspace?: string;
2062
- response: "once" | "always" | "reject";
2063
- }, options?: Options<never, ThrowOnError>): RequestResult<MobilePermissionRespondResponses, unknown, ThrowOnError>;
2064
- }
2065
- export declare class Question2 extends HeyApiClient {
2066
- /**
2067
- * Reject question from mobile
2068
- *
2069
- * Dismiss/reject a pending question request.
2070
- */
2071
- reject<ThrowOnError extends boolean = false>(parameters: {
2072
- sessionID: string;
2073
- requestID: string;
2074
- directory?: string;
2075
- workspace?: string;
2076
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileQuestionRejectResponses, unknown, ThrowOnError>;
2077
- /**
2078
- * Respond to question from mobile
2079
- *
2080
- * Answer a pending question request.
2081
- */
2082
- respond<ThrowOnError extends boolean = false>(parameters: {
2083
- sessionID: string;
2084
- requestID: string;
2085
- directory?: string;
2086
- workspace?: string;
2087
- answers: Array<Array<string>>;
2088
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileQuestionRespondResponses, unknown, ThrowOnError>;
2089
- }
2090
- export declare class Worktree2 extends HeyApiClient {
2091
- /**
2092
- * Remove mobile worktree
2093
- *
2094
- * Remove an existing worktree sandbox.
2095
- */
2096
- remove<ThrowOnError extends boolean = false>(parameters?: {
2097
- directory?: string;
2098
- workspace?: string;
2099
- worktreeRemoveInput?: WorktreeRemoveInput;
2100
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileWorktreeRemoveResponses, unknown, ThrowOnError>;
2101
- /**
2102
- * Create mobile worktree
2103
- *
2104
- * Create a git worktree for sandboxed mobile work.
2105
- */
2106
- create<ThrowOnError extends boolean = false>(parameters?: {
2107
- directory?: string;
2108
- workspace?: string;
2109
- worktreeCreateInput?: WorktreeCreateInput;
2110
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileWorktreeCreateResponses, MobileWorktreeCreateErrors, ThrowOnError>;
2111
- /**
2112
- * Reset mobile worktree
2113
- *
2114
- * Reset a worktree back to the default branch state.
2115
- */
2116
- reset<ThrowOnError extends boolean = false>(parameters?: {
2117
- directory?: string;
2118
- workspace?: string;
2119
- worktreeResetInput?: WorktreeResetInput;
2120
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileWorktreeResetResponses, unknown, ThrowOnError>;
2121
- }
2122
- export declare class Git extends HeyApiClient {
2123
- /**
2124
- * Get git status for mobile
2125
- *
2126
- * Return the current git state including branch, staged/unstaged changes, and untracked files.
2127
- */
2128
- status<ThrowOnError extends boolean = false>(parameters?: {
2129
- directory?: string;
2130
- workspace?: string;
2131
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGitStatusResponses, unknown, ThrowOnError>;
2132
- /**
2133
- * Get git diff for mobile
2134
- *
2135
- * Return parsed file diffs with hunks for the current git state.
2136
- */
2137
- diff<ThrowOnError extends boolean = false>(parameters?: {
2138
- directory?: string;
2139
- workspace?: string;
2140
- file?: string;
2141
- staged?: "true" | "false";
2142
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGitDiffResponses, unknown, ThrowOnError>;
2143
- /**
2144
- * Get git commit history for mobile
2145
- *
2146
- * Return recent commits with stats for the current branch.
2147
- */
2148
- commits<ThrowOnError extends boolean = false>(parameters?: {
2149
- directory?: string;
2150
- workspace?: string;
2151
- limit?: number;
2152
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGitCommitsResponses, unknown, ThrowOnError>;
2153
- /**
2154
- * Get git branches for mobile
2155
- *
2156
- * Return local and remote branches with status.
2157
- */
2158
- branches<ThrowOnError extends boolean = false>(parameters?: {
2159
- directory?: string;
2160
- workspace?: string;
2161
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGitBranchesResponses, unknown, ThrowOnError>;
2162
- /**
2163
- * Create git commit for mobile
2164
- *
2165
- * Stage and commit changes in the current worktree.
2166
- */
2167
- commit<ThrowOnError extends boolean = false>(parameters: {
2168
- directory?: string;
2169
- workspace?: string;
2170
- message: string;
2171
- files?: Array<string>;
2172
- amend?: boolean;
2173
- stagedOnly?: boolean;
2174
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGitCommitResponses, MobileGitCommitErrors, ThrowOnError>;
2175
- /**
2176
- * Checkout git branch for mobile
2177
- *
2178
- * Switch to a different branch in the current worktree.
2179
- */
2180
- checkout<ThrowOnError extends boolean = false>(parameters: {
2181
- directory?: string;
2182
- workspace?: string;
2183
- branch: string;
2184
- create?: boolean;
2185
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGitCheckoutResponses, MobileGitCheckoutErrors, ThrowOnError>;
2186
- /**
2187
- * Stage git files for mobile
2188
- *
2189
- * Add files to the staging area.
2190
- */
2191
- stage<ThrowOnError extends boolean = false>(parameters: {
2192
- directory?: string;
2193
- workspace?: string;
2194
- files: Array<string>;
2195
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGitStageResponses, unknown, ThrowOnError>;
2196
- /**
2197
- * Unstage git files for mobile
2198
- *
2199
- * Remove files from the staging area.
2200
- */
2201
- unstage<ThrowOnError extends boolean = false>(parameters: {
2202
- directory?: string;
2203
- workspace?: string;
2204
- files: Array<string>;
2205
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGitUnstageResponses, unknown, ThrowOnError>;
2206
- /**
2207
- * Discard git changes for mobile
2208
- *
2209
- * Discard uncommitted changes to files.
2210
- */
2211
- discard<ThrowOnError extends boolean = false>(parameters: {
2212
- directory?: string;
2213
- workspace?: string;
2214
- files: Array<string>;
2215
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGitDiscardResponses, unknown, ThrowOnError>;
2216
- /**
2217
- * Push git branch for mobile
2218
- *
2219
- * Push the current branch to the remote.
2220
- */
2221
- push<ThrowOnError extends boolean = false>(parameters?: {
2222
- directory?: string;
2223
- workspace?: string;
2224
- upstream?: string;
2225
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGitPushResponses, MobileGitPushErrors, ThrowOnError>;
2226
- /**
2227
- * Pull git changes for mobile
2228
- *
2229
- * Pull remote changes into the current branch.
2230
- */
2231
- pull<ThrowOnError extends boolean = false>(parameters?: {
2232
- directory?: string;
2233
- workspace?: string;
2234
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileGitPullResponses, MobileGitPullErrors, ThrowOnError>;
2235
- }
2236
- export declare class Runs extends HeyApiClient {
2237
- /**
2238
- * List recent loop runs for mobile
2239
- *
2240
- * List recent runs across all loops in the current project.
2241
- */
2242
- recent<ThrowOnError extends boolean = false>(parameters?: {
2243
- directory?: string;
2244
- workspace?: string;
2245
- limit?: number;
2246
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileLoopRunsRecentResponses, MobileLoopRunsRecentErrors, ThrowOnError>;
2247
- }
2248
- export declare class Loop2 extends HeyApiClient {
2249
- /**
2250
- * List loops for mobile
2251
- *
2252
- * List all autonomous loops for the current project with their live runtime state.
2253
- */
2254
- list<ThrowOnError extends boolean = false>(parameters?: {
2255
- directory?: string;
2256
- workspace?: string;
2257
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileLoopListResponses, MobileLoopListErrors, ThrowOnError>;
2258
- /**
2259
- * Create loop for mobile
2260
- *
2261
- * Create and arm a new autonomous loop.
2262
- */
2263
- create<ThrowOnError extends boolean = false>(parameters?: {
2264
- directory?: string;
2265
- workspace?: string;
2266
- mobileLoopWriteInput?: MobileLoopWriteInput;
2267
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileLoopCreateResponses, MobileLoopCreateErrors, ThrowOnError>;
2268
- /**
2269
- * List loop templates for mobile
2270
- *
2271
- * List built-in loop starters that can be applied in the mobile loop editor.
2272
- */
2273
- templates<ThrowOnError extends boolean = false>(parameters?: {
2274
- directory?: string;
2275
- workspace?: string;
2276
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileLoopTemplatesResponses, unknown, ThrowOnError>;
2277
- /**
2278
- * Generate a loop for mobile
2279
- *
2280
- * Generate a loop draft from a natural-language description.
2281
- */
2282
- generate<ThrowOnError extends boolean = false>(parameters?: {
2283
- directory?: string;
2284
- workspace?: string;
2285
- mobileLoopGenerateInput?: MobileLoopGenerateInput;
2286
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileLoopGenerateResponses, MobileLoopGenerateErrors, ThrowOnError>;
2287
- /**
2288
- * Delete loop for mobile
2289
- *
2290
- * Cancel, disarm, and delete a loop and its run history.
2291
- */
2292
- delete<ThrowOnError extends boolean = false>(parameters: {
2293
- id: string;
2294
- directory?: string;
2295
- workspace?: string;
2296
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileLoopDeleteResponses, MobileLoopDeleteErrors, ThrowOnError>;
2297
- /**
2298
- * Get loop for mobile
2299
- *
2300
- * Get a loop definition and its live runtime.
2301
- */
2302
- get<ThrowOnError extends boolean = false>(parameters: {
2303
- id: string;
2304
- directory?: string;
2305
- workspace?: string;
2306
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileLoopGetResponses, MobileLoopGetErrors, ThrowOnError>;
2307
- /**
2308
- * Update loop for mobile
2309
- *
2310
- * Replace a loop definition and synchronize its schedule.
2311
- */
2312
- update<ThrowOnError extends boolean = false>(parameters: {
2313
- id: string;
2314
- directory?: string;
2315
- workspace?: string;
2316
- mobileLoopWriteInput?: MobileLoopWriteInput;
2317
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileLoopUpdateResponses, MobileLoopUpdateErrors, ThrowOnError>;
2318
- /**
2319
- * List loop runs for mobile
2320
- *
2321
- * List the most recent runs for one loop.
2322
- */
2323
- runs<ThrowOnError extends boolean = false>(parameters: {
2324
- id: string;
2325
- directory?: string;
2326
- workspace?: string;
2327
- limit?: number;
2328
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileLoopRunsResponses, MobileLoopRunsErrors, ThrowOnError>;
2329
- /**
2330
- * Run loop from mobile
2331
- *
2332
- * Trigger an immediate run of a loop.
2333
- */
2334
- run<ThrowOnError extends boolean = false>(parameters: {
2335
- id: string;
2336
- directory?: string;
2337
- workspace?: string;
2338
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileLoopRunResponses, MobileLoopRunErrors, ThrowOnError>;
2339
- /**
2340
- * Abort loop from mobile
2341
- *
2342
- * Cancel the currently running iteration of a loop.
2343
- */
2344
- abort<ThrowOnError extends boolean = false>(parameters: {
2345
- id: string;
2346
- directory?: string;
2347
- workspace?: string;
2348
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileLoopAbortResponses, MobileLoopAbortErrors, ThrowOnError>;
2349
- /**
2350
- * Enable or disable loop from mobile
2351
- *
2352
- * Enable or disable a loop and synchronize its schedule.
2353
- */
2354
- toggle<ThrowOnError extends boolean = false>(parameters: {
2355
- id: string;
2356
- directory?: string;
2357
- workspace?: string;
2358
- enabled: boolean;
2359
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileLoopToggleResponses, MobileLoopToggleErrors, ThrowOnError>;
2360
- /**
2361
- * Pause loop from mobile
2362
- *
2363
- * Pause a loop's interval scheduling.
2364
- */
2365
- pause<ThrowOnError extends boolean = false>(parameters: {
2366
- id: string;
2367
- directory?: string;
2368
- workspace?: string;
2369
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileLoopPauseResponses, MobileLoopPauseErrors, ThrowOnError>;
2370
- /**
2371
- * Resume loop from mobile
2372
- *
2373
- * Resume a paused loop and re-arm its interval schedule.
2374
- */
2375
- resume<ThrowOnError extends boolean = false>(parameters: {
2376
- id: string;
2377
- directory?: string;
2378
- workspace?: string;
2379
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileLoopResumeResponses, MobileLoopResumeErrors, ThrowOnError>;
2380
- private _runs?;
2381
- get runs2(): Runs;
2382
- }
2383
- export declare class Routine extends HeyApiClient {
2384
- /**
2385
- * List routines
2386
- *
2387
- * List all saved routines for the current project.
2388
- */
2389
- list<ThrowOnError extends boolean = false>(parameters?: {
2390
- directory?: string;
2391
- workspace?: string;
2392
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileRoutineListResponses, MobileRoutineListErrors, ThrowOnError>;
2393
- /**
2394
- * Create routine
2395
- *
2396
- * Create a new saved routine.
2397
- */
2398
- create<ThrowOnError extends boolean = false>(parameters?: {
2399
- directory?: string;
2400
- workspace?: string;
2401
- mobileRoutineCreateInput?: MobileRoutineCreateInput;
2402
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileRoutineCreateResponses, MobileRoutineCreateErrors, ThrowOnError>;
2403
- /**
2404
- * Delete routine
2405
- *
2406
- * Delete a routine by ID.
2407
- */
2408
- delete<ThrowOnError extends boolean = false>(parameters: {
2409
- id: string;
2410
- directory?: string;
2411
- workspace?: string;
2412
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileRoutineDeleteResponses, MobileRoutineDeleteErrors, ThrowOnError>;
2413
- /**
2414
- * Get routine
2415
- *
2416
- * Get a single routine by ID.
2417
- */
2418
- get<ThrowOnError extends boolean = false>(parameters: {
2419
- id: string;
2420
- directory?: string;
2421
- workspace?: string;
2422
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileRoutineGetResponses, MobileRoutineGetErrors, ThrowOnError>;
2423
- /**
2424
- * Update routine
2425
- *
2426
- * Update a routine's name, prompt, triggers, or paused state.
2427
- */
2428
- update<ThrowOnError extends boolean = false>(parameters: {
2429
- id: string;
2430
- directory?: string;
2431
- workspace?: string;
2432
- mobileRoutineUpdateInput?: MobileRoutineUpdateInput;
2433
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileRoutineUpdateResponses, MobileRoutineUpdateErrors, ThrowOnError>;
2434
- /**
2435
- * Run routine
2436
- *
2437
- * Trigger an immediate run of a routine, creating a new session.
2438
- */
2439
- run<ThrowOnError extends boolean = false>(parameters: {
2440
- id: string;
2441
- directory?: string;
2442
- workspace?: string;
2443
- mobileRoutineRunInput?: MobileRoutineRunInput;
2444
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileRoutineRunResponses, MobileRoutineRunErrors, ThrowOnError>;
2445
- /**
2446
- * Pause routine
2447
- *
2448
- * Pause a routine, preventing scheduled triggers from firing.
2449
- */
2450
- pause<ThrowOnError extends boolean = false>(parameters: {
2451
- id: string;
2452
- directory?: string;
2453
- workspace?: string;
2454
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileRoutinePauseResponses, MobileRoutinePauseErrors, ThrowOnError>;
2455
- /**
2456
- * Resume routine
2457
- *
2458
- * Resume a paused routine, re-enabling scheduled triggers.
2459
- */
2460
- resume<ThrowOnError extends boolean = false>(parameters: {
2461
- id: string;
2462
- directory?: string;
2463
- workspace?: string;
2464
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileRoutineResumeResponses, MobileRoutineResumeErrors, ThrowOnError>;
2465
- /**
2466
- * API trigger
2467
- *
2468
- * Trigger a routine via its API token. Accepts the token in the path or Authorization: Bearer header.
2469
- */
2470
- trigger<ThrowOnError extends boolean = false>(parameters: {
2471
- token: string;
2472
- directory?: string;
2473
- workspace?: string;
2474
- mobileRoutineTriggerInput?: MobileRoutineTriggerInput;
2475
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileRoutineTriggerResponses, MobileRoutineTriggerErrors, ThrowOnError>;
2476
- }
2477
- export declare class Pty2 extends HeyApiClient {
2478
- /**
2479
- * List PTY sessions for mobile
2480
- *
2481
- * Get a list of all active pseudo-terminal (PTY) sessions managed by Nikcli.
2482
- */
2483
- list<ThrowOnError extends boolean = false>(parameters?: {
2484
- directory?: string;
2485
- workspace?: string;
2486
- }, options?: Options<never, ThrowOnError>): RequestResult<MobilePtyListResponses, unknown, ThrowOnError>;
2487
- /**
2488
- * Create PTY session for mobile
2489
- *
2490
- * Create a new pseudo-terminal (PTY) session for running shell commands and processes.
2491
- */
2492
- create<ThrowOnError extends boolean = false>(parameters?: {
2493
- directory?: string;
2494
- workspace?: string;
2495
- command?: string;
2496
- args?: Array<string>;
2497
- cwd?: string;
2498
- title?: string;
2499
- env?: {
2500
- [key: string]: string;
2501
- };
2502
- }, options?: Options<never, ThrowOnError>): RequestResult<MobilePtyCreateResponses, MobilePtyCreateErrors, ThrowOnError>;
2503
- /**
2504
- * Remove PTY session for mobile
2505
- *
2506
- * Remove and terminate a specific pseudo-terminal (PTY) session.
2507
- */
2508
- remove<ThrowOnError extends boolean = false>(parameters: {
2509
- ptyID: string;
2510
- directory?: string;
2511
- workspace?: string;
2512
- }, options?: Options<never, ThrowOnError>): RequestResult<MobilePtyRemoveResponses, MobilePtyRemoveErrors, ThrowOnError>;
2513
- /**
2514
- * Get PTY session for mobile
2515
- *
2516
- * Retrieve detailed information about a specific pseudo-terminal (PTY) session.
2517
- */
2518
- get<ThrowOnError extends boolean = false>(parameters: {
2519
- ptyID: string;
2520
- directory?: string;
2521
- workspace?: string;
2522
- }, options?: Options<never, ThrowOnError>): RequestResult<MobilePtyGetResponses, MobilePtyGetErrors, ThrowOnError>;
2523
- /**
2524
- * Update PTY session for mobile
2525
- *
2526
- * Update properties of an existing pseudo-terminal (PTY) session.
2527
- */
2528
- update<ThrowOnError extends boolean = false>(parameters: {
2529
- ptyID: string;
2530
- directory?: string;
2531
- workspace?: string;
2532
- title?: string;
2533
- size?: {
2534
- rows: number;
2535
- cols: number;
2536
- };
2537
- }, options?: Options<never, ThrowOnError>): RequestResult<MobilePtyUpdateResponses, MobilePtyUpdateErrors, ThrowOnError>;
2538
- /**
2539
- * Connect to PTY session for mobile
2540
- *
2541
- * Establish a WebSocket connection to interact with a pseudo-terminal (PTY) session in real-time.
2542
- */
2543
- connect<ThrowOnError extends boolean = false>(parameters: {
2544
- ptyID: string;
2545
- directory?: string;
2546
- workspace?: string;
2547
- }, options?: Options<never, ThrowOnError>): RequestResult<MobilePtyConnectResponses, MobilePtyConnectErrors, ThrowOnError>;
2548
- }
2549
- export declare class Mobile extends HeyApiClient {
2550
- /**
2551
- * Get mobile bootstrap payload
2552
- *
2553
- * Return the current mobile bootstrap state for the connected host.
2554
- */
2555
- bootstrap<ThrowOnError extends boolean = false>(parameters?: {
2556
- directory?: string;
2557
- workspace?: string;
2558
- }, options?: Options<never, ThrowOnError>): RequestResult<MobileBootstrapResponses, unknown, ThrowOnError>;
2559
- private _auth?;
2560
- get auth(): Auth2;
2561
- private _command?;
2562
- get command(): Command;
2563
- private _project?;
2564
- get project(): Project2;
2565
- private _memory?;
2566
- get memory(): Memory;
2567
- private _github?;
2568
- get github(): Github;
2569
- private _session?;
2570
- get session(): Session4;
2571
- private _permission?;
2572
- get permission(): Permission2;
2573
- private _question?;
2574
- get question(): Question2;
2575
- private _worktree?;
2576
- get worktree(): Worktree2;
2577
- private _git?;
2578
- get git(): Git;
2579
- private _loop?;
2580
- get loop(): Loop2;
2581
- private _routine?;
2582
- get routine(): Routine;
2583
- private _pty?;
2584
- get pty(): Pty2;
2585
- }
2586
- export declare class Find extends HeyApiClient {
2587
- /**
2588
- * Find text
2589
- *
2590
- * Search for text patterns across files in the project using the configured search backend.
2591
- */
2592
- text<ThrowOnError extends boolean = false>(parameters: {
2593
- directory?: string;
2594
- workspace?: string;
2595
- pattern: string;
2596
- }, options?: Options<never, ThrowOnError>): RequestResult<FindTextResponses, unknown, ThrowOnError>;
2597
- /**
2598
- * Find files
2599
- *
2600
- * Search for files or directories by name or pattern in the project directory.
2601
- */
2602
- files<ThrowOnError extends boolean = false>(parameters: {
2603
- directory?: string;
2604
- workspace?: string;
2605
- query: string;
2606
- dirs?: "true" | "false";
2607
- type?: "file" | "directory";
2608
- limit?: number;
2609
- }, options?: Options<never, ThrowOnError>): RequestResult<FindFilesResponses, unknown, ThrowOnError>;
2610
- /**
2611
- * Find symbols
2612
- *
2613
- * Search for workspace symbols like functions, classes, and variables using LSP.
2614
- */
2615
- symbols<ThrowOnError extends boolean = false>(parameters: {
2616
- directory?: string;
2617
- workspace?: string;
2618
- query: string;
2619
- }, options?: Options<never, ThrowOnError>): RequestResult<FindSymbolsResponses, unknown, ThrowOnError>;
2620
- }
2621
- export declare class File_ extends HeyApiClient {
2622
- /**
2623
- * List files
2624
- *
2625
- * List files and directories in a specified path.
2626
- */
2627
- list<ThrowOnError extends boolean = false>(parameters: {
2628
- directory?: string;
2629
- workspace?: string;
2630
- path: string;
2631
- }, options?: Options<never, ThrowOnError>): RequestResult<FileListResponses, unknown, ThrowOnError>;
2632
- /**
2633
- * Read file
2634
- *
2635
- * Read the content of a specified file.
2636
- */
2637
- read<ThrowOnError extends boolean = false>(parameters: {
2638
- directory?: string;
2639
- workspace?: string;
2640
- path: string;
2641
- }, options?: Options<never, ThrowOnError>): RequestResult<FileReadResponses, unknown, ThrowOnError>;
2642
- /**
2643
- * Write file
2644
- *
2645
- * Write content to a specified file within the project directory.
2646
- */
2647
- write<ThrowOnError extends boolean = false>(parameters: {
2648
- directory?: string;
2649
- workspace?: string;
2650
- path: string;
2651
- content: string;
2652
- }, options?: Options<never, ThrowOnError>): RequestResult<FileWriteResponses, unknown, ThrowOnError>;
2653
- /**
2654
- * Get file status
2655
- *
2656
- * Get the git status of all files in the project.
2657
- */
2658
- status<ThrowOnError extends boolean = false>(parameters?: {
2659
- directory?: string;
2660
- workspace?: string;
2661
- }, options?: Options<never, ThrowOnError>): RequestResult<FileStatusResponses, unknown, ThrowOnError>;
2662
- }
2663
- export declare class Auth4 extends HeyApiClient {
2664
- /**
2665
- * Remove connector credentials
2666
- *
2667
- * Remove stored credentials for a connector.
2668
- */
2669
- remove<ThrowOnError extends boolean = false>(parameters: {
2670
- name: string;
2671
- directory?: string;
2672
- workspace?: string;
2673
- }, options?: Options<never, ThrowOnError>): RequestResult<ConnectorsAuthRemoveResponses, ConnectorsAuthRemoveErrors, ThrowOnError>;
2674
- /**
2675
- * Set connector credentials
2676
- *
2677
- * Store credentials for a connector.
2678
- */
2679
- set<ThrowOnError extends boolean = false>(parameters: {
2680
- name: string;
2681
- directory?: string;
2682
- workspace?: string;
2683
- token?: string;
2684
- botToken?: string;
2685
- apiKey?: string;
2686
- teamId?: string;
2687
- expiresAt?: number;
2688
- refreshToken?: string;
2689
- refreshTokenExpiresAt?: number;
2690
- }, options?: Options<never, ThrowOnError>): RequestResult<ConnectorsAuthSetResponses, ConnectorsAuthSetErrors, ThrowOnError>;
2691
- }
2692
- export declare class Connectors extends HeyApiClient {
2693
- /**
2694
- * Get connectors status
2695
- *
2696
- * Get the status of all configured external service connectors.
2697
- */
2698
- status<ThrowOnError extends boolean = false>(parameters?: {
2699
- directory?: string;
2700
- workspace?: string;
2701
- }, options?: Options<never, ThrowOnError>): RequestResult<ConnectorsStatusResponses, unknown, ThrowOnError>;
2702
- /**
2703
- * Invalidate connector cache
2704
- *
2705
- * Clear connector status and tools cache. Optionally invalidate a specific connector.
2706
- */
2707
- invalidate<ThrowOnError extends boolean = false>(parameters?: {
2708
- directory?: string;
2709
- workspace?: string;
2710
- name?: string;
2711
- }, options?: Options<never, ThrowOnError>): RequestResult<ConnectorsInvalidateResponses, unknown, ThrowOnError>;
2712
- private _auth?;
2713
- get auth(): Auth4;
2714
- }
2715
- export declare class Auth5 extends HeyApiClient {
2716
- /**
2717
- * Remove MCP OAuth
2718
- *
2719
- * Remove OAuth credentials for an MCP server
2720
- */
2721
- remove<ThrowOnError extends boolean = false>(parameters: {
2722
- name: string;
2723
- directory?: string;
2724
- workspace?: string;
2725
- }, options?: Options<never, ThrowOnError>): RequestResult<McpAuthRemoveResponses, McpAuthRemoveErrors, ThrowOnError>;
2726
- /**
2727
- * Start MCP OAuth
2728
- *
2729
- * Start OAuth authentication flow for a Model Context Protocol (MCP) server.
2730
- */
2731
- start<ThrowOnError extends boolean = false>(parameters: {
2732
- name: string;
2733
- directory?: string;
2734
- workspace?: string;
2735
- }, options?: Options<never, ThrowOnError>): RequestResult<McpAuthStartResponses, McpAuthStartErrors, ThrowOnError>;
2736
- /**
2737
- * Complete MCP OAuth
2738
- *
2739
- * Complete OAuth authentication for a Model Context Protocol (MCP) server using the authorization code.
2740
- */
2741
- callback<ThrowOnError extends boolean = false>(parameters: {
2742
- name: string;
2743
- directory?: string;
2744
- workspace?: string;
2745
- code: string;
2746
- }, options?: Options<never, ThrowOnError>): RequestResult<McpAuthCallbackResponses, McpAuthCallbackErrors, ThrowOnError>;
2747
- /**
2748
- * Authenticate MCP OAuth
2749
- *
2750
- * Start OAuth flow and wait for callback (opens browser)
2751
- */
2752
- authenticate<ThrowOnError extends boolean = false>(parameters: {
2753
- name: string;
2754
- directory?: string;
2755
- workspace?: string;
2756
- }, options?: Options<never, ThrowOnError>): RequestResult<McpAuthAuthenticateResponses, McpAuthAuthenticateErrors, ThrowOnError>;
2757
- }
2758
- export declare class Mcp extends HeyApiClient {
2759
- /**
2760
- * Get MCP status
2761
- *
2762
- * Get the status of all Model Context Protocol (MCP) servers.
2763
- */
2764
- status<ThrowOnError extends boolean = false>(parameters?: {
2765
- directory?: string;
2766
- workspace?: string;
2767
- }, options?: Options<never, ThrowOnError>): RequestResult<McpStatusResponses, unknown, ThrowOnError>;
2768
- /**
2769
- * Add MCP server
2770
- *
2771
- * Dynamically add a new Model Context Protocol (MCP) server to the system.
2772
- */
2773
- add<ThrowOnError extends boolean = false>(parameters: {
2774
- directory?: string;
2775
- workspace?: string;
2776
- name: string;
2777
- config: McpLocalConfig | McpRemoteConfig;
2778
- }, options?: Options<never, ThrowOnError>): RequestResult<McpAddResponses, McpAddErrors, ThrowOnError>;
2779
- /**
2780
- * Connect an MCP server
2781
- */
2782
- connect<ThrowOnError extends boolean = false>(parameters: {
2783
- name: string;
2784
- directory?: string;
2785
- workspace?: string;
2786
- }, options?: Options<never, ThrowOnError>): RequestResult<McpConnectResponses, unknown, ThrowOnError>;
2787
- /**
2788
- * Disconnect an MCP server
2789
- */
2790
- disconnect<ThrowOnError extends boolean = false>(parameters: {
2791
- name: string;
2792
- directory?: string;
2793
- workspace?: string;
2794
- }, options?: Options<never, ThrowOnError>): RequestResult<McpDisconnectResponses, unknown, ThrowOnError>;
2795
- /**
2796
- * Enable or disable an MCP server
2797
- */
2798
- toggle<ThrowOnError extends boolean = false>(parameters: {
2799
- name: string;
2800
- directory?: string;
2801
- workspace?: string;
2802
- enabled: boolean;
2803
- }, options?: Options<never, ThrowOnError>): RequestResult<McpToggleResponses, McpToggleErrors, ThrowOnError>;
2804
- private _auth?;
2805
- get auth(): Auth5;
2806
- }
2807
- export declare class Control extends HeyApiClient {
2808
- /**
2809
- * Get next TUI request
2810
- *
2811
- * Retrieve the next TUI (Terminal User Interface) request from the queue for processing.
2812
- */
2813
- next<ThrowOnError extends boolean = false>(parameters?: {
2814
- directory?: string;
2815
- workspace?: string;
2816
- }, options?: Options<never, ThrowOnError>): RequestResult<TuiControlNextResponses, unknown, ThrowOnError>;
2817
- /**
2818
- * Submit TUI response
2819
- *
2820
- * Submit a response to the TUI request queue to complete a pending request.
2821
- */
2822
- response<ThrowOnError extends boolean = false>(parameters?: {
2823
- directory?: string;
2824
- workspace?: string;
2825
- body?: unknown;
2826
- }, options?: Options<never, ThrowOnError>): RequestResult<TuiControlResponseResponses, unknown, ThrowOnError>;
2827
- }
2828
- export declare class Tui extends HeyApiClient {
2829
- /**
2830
- * Append TUI prompt
2831
- *
2832
- * Append prompt to the TUI
2833
- */
2834
- appendPrompt<ThrowOnError extends boolean = false>(parameters: {
2835
- directory?: string;
2836
- workspace?: string;
2837
- text: string;
2838
- }, options?: Options<never, ThrowOnError>): RequestResult<TuiAppendPromptResponses, TuiAppendPromptErrors, ThrowOnError>;
2839
- /**
2840
- * Open help dialog
2841
- *
2842
- * Open the help dialog in the TUI to display user assistance information.
2843
- */
2844
- openHelp<ThrowOnError extends boolean = false>(parameters?: {
2845
- directory?: string;
2846
- workspace?: string;
2847
- }, options?: Options<never, ThrowOnError>): RequestResult<TuiOpenHelpResponses, unknown, ThrowOnError>;
2848
- /**
2849
- * Open sessions dialog
2850
- *
2851
- * Open the session dialog
2852
- */
2853
- openSessions<ThrowOnError extends boolean = false>(parameters?: {
2854
- directory?: string;
2855
- workspace?: string;
2856
- }, options?: Options<never, ThrowOnError>): RequestResult<TuiOpenSessionsResponses, unknown, ThrowOnError>;
2857
- /**
2858
- * Open themes dialog
2859
- *
2860
- * Open the theme dialog
2861
- */
2862
- openThemes<ThrowOnError extends boolean = false>(parameters?: {
2863
- directory?: string;
2864
- workspace?: string;
2865
- }, options?: Options<never, ThrowOnError>): RequestResult<TuiOpenThemesResponses, unknown, ThrowOnError>;
2866
- /**
2867
- * Open models dialog
2868
- *
2869
- * Open the model dialog
2870
- */
2871
- openModels<ThrowOnError extends boolean = false>(parameters?: {
2872
- directory?: string;
2873
- workspace?: string;
2874
- }, options?: Options<never, ThrowOnError>): RequestResult<TuiOpenModelsResponses, unknown, ThrowOnError>;
2875
- /**
2876
- * Submit TUI prompt
2877
- *
2878
- * Submit the prompt
2879
- */
2880
- submitPrompt<ThrowOnError extends boolean = false>(parameters?: {
2881
- directory?: string;
2882
- workspace?: string;
2883
- }, options?: Options<never, ThrowOnError>): RequestResult<TuiSubmitPromptResponses, unknown, ThrowOnError>;
2884
- /**
2885
- * Clear TUI prompt
2886
- *
2887
- * Clear the prompt
2888
- */
2889
- clearPrompt<ThrowOnError extends boolean = false>(parameters?: {
2890
- directory?: string;
2891
- workspace?: string;
2892
- }, options?: Options<never, ThrowOnError>): RequestResult<TuiClearPromptResponses, unknown, ThrowOnError>;
2893
- /**
2894
- * Execute TUI command
2895
- *
2896
- * Execute a TUI command (e.g. agent_cycle)
2897
- */
2898
- executeCommand<ThrowOnError extends boolean = false>(parameters: {
2899
- directory?: string;
2900
- workspace?: string;
2901
- command: string;
2902
- }, options?: Options<never, ThrowOnError>): RequestResult<TuiExecuteCommandResponses, TuiExecuteCommandErrors, ThrowOnError>;
2903
- /**
2904
- * Show TUI toast
2905
- *
2906
- * Show a toast notification in the TUI
2907
- */
2908
- showToast<ThrowOnError extends boolean = false>(parameters: {
2909
- directory?: string;
2910
- workspace?: string;
2911
- title?: string;
2912
- message: string;
2913
- variant: "info" | "success" | "warning" | "error";
2914
- duration?: number;
2915
- }, options?: Options<never, ThrowOnError>): RequestResult<TuiShowToastResponses, unknown, ThrowOnError>;
2916
- /**
2917
- * Publish TUI event
2918
- *
2919
- * Publish a TUI event
2920
- */
2921
- publish<ThrowOnError extends boolean = false>(parameters?: {
2922
- directory?: string;
2923
- workspace?: string;
2924
- body?: EventTuiPromptAppend | EventTuiCommandExecute | EventTuiToastShow | EventTuiSessionSelect;
2925
- }, options?: Options<never, ThrowOnError>): RequestResult<TuiPublishResponses, TuiPublishErrors, ThrowOnError>;
2926
- /**
2927
- * Select session
2928
- *
2929
- * Navigate the TUI to display the specified session.
2930
- */
2931
- selectSession<ThrowOnError extends boolean = false>(parameters: {
2932
- directory?: string;
2933
- workspace?: string;
2934
- sessionID: string;
2935
- }, options?: Options<never, ThrowOnError>): RequestResult<TuiSelectSessionResponses, TuiSelectSessionErrors, ThrowOnError>;
2936
- private _control?;
2937
- get control(): Control;
2938
- }
2939
- export declare class Analytics extends HeyApiClient {
2940
- /**
2941
- * Get global analytics
2942
- *
2943
- * Retrieve cumulative global analytics across all sessions.
2944
- */
2945
- global<ThrowOnError extends boolean = false>(parameters?: {
2946
- directory?: string;
2947
- workspace?: string;
2948
- }, options?: Options<never, ThrowOnError>): RequestResult<AnalyticsGlobalResponses, unknown, ThrowOnError>;
2949
- /**
2950
- * Get daily analytics
2951
- *
2952
- * Retrieve daily analytics snapshots for a date range.
2953
- */
2954
- daily<ThrowOnError extends boolean = false>(parameters?: {
2955
- directory?: string;
2956
- workspace?: string;
2957
- from?: string;
2958
- to?: string;
2959
- days?: string;
2960
- }, options?: Options<never, ThrowOnError>): RequestResult<AnalyticsDailyResponses, unknown, ThrowOnError>;
2961
- /**
2962
- * Get session analytics
2963
- *
2964
- * Retrieve analytics for a specific session.
2965
- */
2966
- session<ThrowOnError extends boolean = false>(parameters: {
2967
- sessionID: string;
2968
- directory?: string;
2969
- workspace?: string;
2970
- }, options?: Options<never, ThrowOnError>): RequestResult<AnalyticsSessionResponses, AnalyticsSessionErrors, ThrowOnError>;
2971
- /**
2972
- * Get all session analytics
2973
- *
2974
- * Retrieve analytics summaries for all completed sessions.
2975
- */
2976
- sessions<ThrowOnError extends boolean = false>(parameters?: {
2977
- directory?: string;
2978
- workspace?: string;
2979
- }, options?: Options<never, ThrowOnError>): RequestResult<AnalyticsSessionsResponses, unknown, ThrowOnError>;
2980
- /**
2981
- * Get analytics leaderboard
2982
- *
2983
- * Retrieve ranked models, providers, and tools by various metrics.
2984
- */
2985
- leaderboard<ThrowOnError extends boolean = false>(parameters?: {
2986
- directory?: string;
2987
- workspace?: string;
2988
- }, options?: Options<never, ThrowOnError>): RequestResult<AnalyticsLeaderboardResponses, unknown, ThrowOnError>;
2989
- /**
2990
- * Get the /data dataset
2991
- *
2992
- * Aggregate usage for a public data page: models ranked by tokens with a daily series, cost per session, blended price per million, cache ratio and share by model author. Computed from the local rollups; returns 204 when the window holds no tokens.
2993
- */
2994
- data<ThrowOnError extends boolean = false>(parameters?: {
2995
- directory?: string;
2996
- workspace?: string;
2997
- days?: string;
2998
- seriesDays?: string;
2999
- }, options?: Options<never, ThrowOnError>): RequestResult<AnalyticsDataResponses, unknown, ThrowOnError>;
3000
- }
3001
- export declare class Brain extends HeyApiClient {
3002
- /**
3003
- * Get brain status
3004
- *
3005
- * Memory-consolidation configuration and readiness.
3006
- */
3007
- status<ThrowOnError extends boolean = false>(parameters?: {
3008
- directory?: string;
3009
- workspace?: string;
3010
- }, options?: Options<never, ThrowOnError>): RequestResult<BrainStatusResponses, unknown, ThrowOnError>;
3011
- /**
3012
- * Trigger brain run
3013
- *
3014
- * Run a memory-consolidation session now. Pass force to bypass thresholds.
3015
- */
3016
- trigger<ThrowOnError extends boolean = false>(parameters?: {
3017
- directory?: string;
3018
- workspace?: string;
3019
- brainTriggerInput?: BrainTriggerInput;
3020
- }, options?: Options<never, ThrowOnError>): RequestResult<BrainTriggerResponses, BrainTriggerErrors, ThrowOnError>;
3021
- }
3022
- export declare class Doctor extends HeyApiClient {
3023
- /**
3024
- * Run nikcli doctor
3025
- *
3026
- * Run the diagnostic checks and return a structured report.
3027
- */
3028
- run<ThrowOnError extends boolean = false>(parameters?: {
3029
- directory?: string;
3030
- workspace?: string;
3031
- }, options?: Options<never, ThrowOnError>): RequestResult<DoctorRunResponses, unknown, ThrowOnError>;
3032
- }
3033
- export declare class Instance extends HeyApiClient {
3034
- /**
3035
- * Dispose instance
3036
- *
3037
- * Clean up and dispose the current Nikcli instance, releasing all resources.
3038
- */
3039
- dispose<ThrowOnError extends boolean = false>(parameters?: {
3040
- directory?: string;
3041
- workspace?: string;
3042
- }, options?: Options<never, ThrowOnError>): RequestResult<InstanceDisposeResponses, unknown, ThrowOnError>;
3043
- }
3044
- export declare class Path extends HeyApiClient {
3045
- /**
3046
- * Get paths
3047
- *
3048
- * Retrieve the current working directory and related path information for the Nikcli instance.
3049
- */
3050
- get<ThrowOnError extends boolean = false>(parameters?: {
3051
- directory?: string;
3052
- workspace?: string;
3053
- }, options?: Options<never, ThrowOnError>): RequestResult<PathGetResponses, unknown, ThrowOnError>;
3054
- }
3055
- export declare class Diff extends HeyApiClient {
3056
- /**
3057
- * Get raw VCS diff
3058
- *
3059
- * Retrieve a raw patch for current uncommitted changes.
3060
- */
3061
- raw<ThrowOnError extends boolean = false>(parameters?: {
3062
- directory?: string;
3063
- workspace?: string;
3064
- }, options?: Options<never, ThrowOnError>): RequestResult<VcsDiffRawResponses, unknown, ThrowOnError>;
3065
- }
3066
- export declare class Vcs extends HeyApiClient {
3067
- /**
3068
- * Get VCS info
3069
- *
3070
- * Retrieve version control system (VCS) information for the current project, such as git branch.
3071
- */
3072
- get<ThrowOnError extends boolean = false>(parameters?: {
3073
- directory?: string;
3074
- workspace?: string;
3075
- }, options?: Options<never, ThrowOnError>): RequestResult<VcsGetResponses, unknown, ThrowOnError>;
3076
- /**
3077
- * Get VCS status
3078
- *
3079
- * Retrieve changed files in the current working tree without patches.
3080
- */
3081
- status<ThrowOnError extends boolean = false>(parameters?: {
3082
- directory?: string;
3083
- workspace?: string;
3084
- }, options?: Options<never, ThrowOnError>): RequestResult<VcsStatusResponses, unknown, ThrowOnError>;
3085
- /**
3086
- * Apply VCS patch
3087
- *
3088
- * Apply a raw patch to the current working tree.
3089
- */
3090
- apply<ThrowOnError extends boolean = false>(parameters?: {
3091
- directory?: string;
3092
- workspace?: string;
3093
- vcsApplyInput?: VcsApplyInput;
3094
- }, options?: Options<never, ThrowOnError>): RequestResult<VcsApplyResponses, VcsApplyErrors, ThrowOnError>;
3095
- private _diff?;
3096
- get diff(): Diff;
3097
- }
3098
- export declare class Command3 extends HeyApiClient {
3099
- /**
3100
- * List commands
3101
- *
3102
- * Get a list of all available commands in the Nikcli system.
3103
- */
3104
- list<ThrowOnError extends boolean = false>(parameters?: {
3105
- directory?: string;
3106
- workspace?: string;
3107
- }, options?: Options<never, ThrowOnError>): RequestResult<CommandListResponses, unknown, ThrowOnError>;
3108
- }
3109
- export declare class Skill extends HeyApiClient {
3110
- /**
3111
- * Create skill
3112
- *
3113
- * Create a new skill with a SKILL.md file.
3114
- */
3115
- create<ThrowOnError extends boolean = false>(parameters: {
3116
- directory?: string;
3117
- workspace?: string;
3118
- name: string;
3119
- description: string;
3120
- category?: string;
3121
- tags?: Array<string>;
3122
- content?: string;
3123
- scope?: "workspace" | "global";
3124
- }, options?: Options<never, ThrowOnError>): RequestResult<AppSkillCreateResponses, AppSkillCreateErrors, ThrowOnError>;
3125
- /**
3126
- * Delete skill
3127
- *
3128
- * Delete a skill by name.
3129
- */
3130
- delete<ThrowOnError extends boolean = false>(parameters: {
3131
- name: string;
3132
- directory?: string;
3133
- workspace?: string;
3134
- }, options?: Options<never, ThrowOnError>): RequestResult<AppSkillDeleteResponses, AppSkillDeleteErrors, ThrowOnError>;
3135
- }
3136
- export declare class App extends HeyApiClient {
3137
- /**
3138
- * Write log
3139
- *
3140
- * Write a log entry to the server logs with specified level and metadata.
3141
- */
3142
- log<ThrowOnError extends boolean = false>(parameters: {
3143
- directory?: string;
3144
- workspace?: string;
3145
- service: string;
3146
- level: "debug" | "info" | "error" | "warn";
3147
- message: string;
3148
- extra?: {
3149
- [key: string]: unknown;
3150
- };
3151
- }, options?: Options<never, ThrowOnError>): RequestResult<AppLogResponses, AppLogErrors, ThrowOnError>;
3152
- /**
3153
- * List agents
3154
- *
3155
- * Get a list of all available AI agents in the Nikcli system.
3156
- */
3157
- agents<ThrowOnError extends boolean = false>(parameters?: {
3158
- directory?: string;
3159
- workspace?: string;
3160
- }, options?: Options<never, ThrowOnError>): RequestResult<AppAgentsResponses, unknown, ThrowOnError>;
3161
- /**
3162
- * List skills
3163
- *
3164
- * Get a list of all available skills in the Nikcli system.
3165
- */
3166
- skills<ThrowOnError extends boolean = false>(parameters?: {
3167
- directory?: string;
3168
- workspace?: string;
3169
- }, options?: Options<never, ThrowOnError>): RequestResult<AppSkillsResponses, unknown, ThrowOnError>;
3170
- private _skill?;
3171
- get skill(): Skill;
3172
- }
3173
- export declare class Lsp extends HeyApiClient {
3174
- /**
3175
- * Get LSP status
3176
- *
3177
- * Get LSP server status
3178
- */
3179
- status<ThrowOnError extends boolean = false>(parameters?: {
3180
- directory?: string;
3181
- workspace?: string;
3182
- }, options?: Options<never, ThrowOnError>): RequestResult<LspStatusResponses, unknown, ThrowOnError>;
3183
- }
3184
- export declare class Formatter extends HeyApiClient {
3185
- /**
3186
- * Get formatter status
3187
- *
3188
- * Get formatter status
3189
- */
3190
- status<ThrowOnError extends boolean = false>(parameters?: {
3191
- directory?: string;
3192
- workspace?: string;
3193
- }, options?: Options<never, ThrowOnError>): RequestResult<FormatterStatusResponses, unknown, ThrowOnError>;
3194
- }
3195
- export declare class Auth6 extends HeyApiClient {
3196
- /**
3197
- * Remove auth credentials
3198
- *
3199
- * Remove stored authentication credentials for a provider
3200
- */
3201
- remove<ThrowOnError extends boolean = false>(parameters: {
3202
- providerID: string;
3203
- directory?: string;
3204
- workspace?: string;
3205
- }, options?: Options<never, ThrowOnError>): RequestResult<AuthRemoveResponses, AuthRemoveErrors, ThrowOnError>;
3206
- /**
3207
- * Set auth credentials
3208
- *
3209
- * Set authentication credentials
3210
- */
3211
- set<ThrowOnError extends boolean = false>(parameters: {
3212
- providerID: string;
3213
- directory?: string;
3214
- workspace?: string;
3215
- auth?: Auth7;
3216
- }, options?: Options<never, ThrowOnError>): RequestResult<AuthSetResponses, AuthSetErrors, ThrowOnError>;
3217
- }
3218
- export declare class Event2 extends HeyApiClient {
3219
- /**
3220
- * Subscribe to events
3221
- *
3222
- * Get events
3223
- */
3224
- subscribe<ThrowOnError extends boolean = false>(parameters?: {
3225
- directory?: string;
3226
- workspace?: string;
3227
- }, options?: Options<never, ThrowOnError, EventSubscribeResponse>): Promise<ServerSentEventsResult<EventSubscribeResponses>>;
3228
- }
3229
- export declare class NikcliClient extends HeyApiClient {
3230
- static readonly __registry: HeyApiRegistry<NikcliClient>;
3231
- constructor(args?: {
3232
- client?: Client;
3233
- key?: string;
3234
- });
3235
- getSShareId<ThrowOnError extends boolean = false>(parameters: {
3236
- shareID: string;
3237
- }, options?: Options<never, ThrowOnError>): RequestResult<GetSShareIdResponses, unknown, ThrowOnError>;
3238
- getShareShareId<ThrowOnError extends boolean = false>(parameters: {
3239
- shareID: string;
3240
- }, options?: Options<never, ThrowOnError>): RequestResult<GetShareShareIdResponses, unknown, ThrowOnError>;
3241
- getApiShareShareId<ThrowOnError extends boolean = false>(parameters: {
3242
- shareID: string;
3243
- }, options?: Options<never, ThrowOnError>): RequestResult<GetApiShareShareIdResponses, unknown, ThrowOnError>;
3244
- getApiShareShareIdData<ThrowOnError extends boolean = false>(parameters: {
3245
- shareID: string;
3246
- }, options?: Options<never, ThrowOnError>): RequestResult<GetApiShareShareIdDataResponses, unknown, ThrowOnError>;
3247
- postConfigMcp<ThrowOnError extends boolean = false>(parameters: {
3248
- directory?: string;
3249
- workspace?: string;
3250
- name: string;
3251
- config: McpLocalConfig | McpRemoteConfig;
3252
- }, options?: Options<never, ThrowOnError>): RequestResult<PostConfigMcpResponses, unknown, ThrowOnError>;
3253
- deleteConfigMcpName<ThrowOnError extends boolean = false>(parameters: {
3254
- name: string;
3255
- directory?: string;
3256
- workspace?: string;
3257
- }, options?: Options<never, ThrowOnError>): RequestResult<DeleteConfigMcpNameResponses, unknown, ThrowOnError>;
3258
- patchConfigMcpName<ThrowOnError extends boolean = false>(parameters: {
3259
- name: string;
3260
- directory?: string;
3261
- workspace?: string;
3262
- body?: {
3263
- [key: string]: unknown;
3264
- };
3265
- }, options?: Options<never, ThrowOnError>): RequestResult<PatchConfigMcpNameResponses, unknown, ThrowOnError>;
3266
- postConfigProfiles<ThrowOnError extends boolean = false>(parameters: {
3267
- directory?: string;
3268
- workspace?: string;
3269
- name: string;
3270
- }, options?: Options<never, ThrowOnError>): RequestResult<PostConfigProfilesResponses, unknown, ThrowOnError>;
3271
- postConfigProfilesActivateName<ThrowOnError extends boolean = false>(parameters: {
3272
- name: string;
3273
- directory?: string;
3274
- workspace?: string;
3275
- }, options?: Options<never, ThrowOnError>): RequestResult<PostConfigProfilesActivateNameResponses, unknown, ThrowOnError>;
3276
- postUserRegister<ThrowOnError extends boolean = false>(parameters: {
3277
- directory?: string;
3278
- workspace?: string;
3279
- username: string;
3280
- email: string;
3281
- password: unknown & unknown & unknown;
3282
- displayName?: string;
3283
- }, options?: Options<never, ThrowOnError>): RequestResult<PostUserRegisterResponses, unknown, ThrowOnError>;
3284
- postUserLogin<ThrowOnError extends boolean = false>(parameters: {
3285
- directory?: string;
3286
- workspace?: string;
3287
- email: string;
3288
- password: string;
3289
- }, options?: Options<never, ThrowOnError>): RequestResult<PostUserLoginResponses, unknown, ThrowOnError>;
3290
- patchUserId<ThrowOnError extends boolean = false>(parameters: {
3291
- id: string;
3292
- directory?: string;
3293
- workspace?: string;
3294
- displayName?: string;
3295
- password?: string;
3296
- role?: "admin" | "user";
3297
- }, options?: Options<never, ThrowOnError>): RequestResult<PatchUserIdResponses, unknown, ThrowOnError>;
3298
- private _global?;
3299
- get global(): Global;
3300
- private _project?;
3301
- get project(): Project;
3302
- private _loop?;
3303
- get loop(): Loop;
3304
- private _mission?;
3305
- get mission(): Mission;
3306
- private _pty?;
3307
- get pty(): Pty;
3308
- private _config?;
3309
- get config(): Config;
3310
- private _tool?;
3311
- get tool(): Tool;
3312
- private _worktree?;
3313
- get worktree(): Worktree;
3314
- private _experimental?;
3315
- get experimental(): Experimental;
3316
- private _managedWorktree?;
3317
- get managedWorktree(): ManagedWorktree;
3318
- private _session?;
3319
- get session(): Session2;
3320
- private _part?;
3321
- get part(): Part;
3322
- private _permission?;
3323
- get permission(): Permission;
3324
- private _sync?;
3325
- get sync(): Sync;
3326
- private _question?;
3327
- get question(): Question;
3328
- private _provider?;
3329
- get provider(): Provider;
3330
- private _mobile?;
3331
- get mobile(): Mobile;
3332
- private _find?;
3333
- get find(): Find;
3334
- private _file?;
3335
- get file(): File_;
3336
- private _connectors?;
3337
- get connectors(): Connectors;
3338
- private _mcp?;
3339
- get mcp(): Mcp;
3340
- private _tui?;
3341
- get tui(): Tui;
3342
- private _analytics?;
3343
- get analytics(): Analytics;
3344
- private _brain?;
3345
- get brain(): Brain;
3346
- private _doctor?;
3347
- get doctor(): Doctor;
3348
- private _instance?;
3349
- get instance(): Instance;
3350
- private _path?;
3351
- get path(): Path;
3352
- private _vcs?;
3353
- get vcs(): Vcs;
3354
- private _command?;
3355
- get command(): Command3;
3356
- private _app?;
3357
- get app(): App;
3358
- private _lsp?;
3359
- get lsp(): Lsp;
3360
- private _formatter?;
3361
- get formatter(): Formatter;
3362
- private _auth?;
3363
- get auth(): Auth6;
3364
- private _event?;
3365
- get event(): Event2;
3366
- }
3367
- export {};