kimaki 0.26.0 → 0.28.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.
- package/dist/agent-model.e2e.test.js +250 -164
- package/dist/anthropic-account-identity.js +9 -1
- package/dist/anthropic-auth-plugin.js +10 -13
- package/dist/anthropic-auth-plugin.test.js +17 -0
- package/dist/anthropic-auth-state.js +1 -0
- package/dist/bash-tool-schema-plugin.js +32 -0
- package/dist/bash-tool-schema-plugin.test.js +49 -0
- package/dist/bin.js +73 -19
- package/dist/cli-commands/maintenance.js +46 -7
- package/dist/cli-commands/project.js +11 -27
- package/dist/cli-commands/send.js +30 -1
- package/dist/cli-commands/session.js +322 -90
- package/dist/cli-commands/task.js +34 -15
- package/dist/cli-parsing.test.js +83 -4
- package/dist/cli-runner.js +44 -8
- package/dist/cli-runner.test.js +27 -0
- package/dist/cli-send-thread.e2e.test.js +9 -9
- package/dist/cli.js +32 -0
- package/dist/commands/abort.js +5 -1
- package/dist/commands/action-buttons.js +2 -1
- package/dist/commands/add-project.js +4 -7
- package/dist/commands/agent.js +164 -32
- package/dist/commands/ask-question.js +23 -33
- package/dist/commands/ask-question.test.js +43 -1
- package/dist/commands/btw.js +28 -6
- package/dist/commands/file-upload.js +2 -1
- package/dist/commands/fork-subagent.js +2 -4
- package/dist/commands/fork.js +4 -4
- package/dist/commands/last-sessions.js +17 -10
- package/dist/commands/login.js +6 -0
- package/dist/commands/merge-worktree.js +47 -14
- package/dist/commands/model-variant.js +8 -1
- package/dist/commands/model.js +16 -9
- package/dist/commands/multioauth.js +1 -0
- package/dist/commands/new-worktree.js +170 -102
- package/dist/commands/queue.js +3 -2
- package/dist/commands/resume.js +4 -4
- package/dist/commands/session.js +78 -63
- package/dist/commands/user-command.js +6 -8
- package/dist/commands/worktrees.js +5 -13
- package/dist/config.js +16 -1
- package/dist/cpu-profiler.js +211 -0
- package/dist/cpu-profiler.test.js +160 -0
- package/dist/database.js +152 -3
- package/dist/db.js +33 -0
- package/dist/db.test.js +267 -1
- package/dist/default-channel-provisioning.test.js +148 -0
- package/dist/discord-bot.js +517 -488
- package/dist/discord-command-registration.js +25 -10
- package/dist/discord-command-registration.test.js +17 -0
- package/dist/discord-utils.js +97 -5
- package/dist/discord-utils.test.js +151 -1
- package/dist/errors.js +10 -0
- package/dist/exec-async.js +17 -5
- package/dist/external-directory-permissions.e2e.test.js +11 -7
- package/dist/external-directory-project-deny.e2e.test.js +5 -3
- package/dist/external-opencode-sync.js +94 -17
- package/dist/external-opencode-sync.test.js +206 -0
- package/dist/extract-sdk-error-message.test.js +13 -0
- package/dist/file-edit-log.js +197 -0
- package/dist/file-edit-log.test.js +258 -0
- package/dist/format-tables.js +52 -0
- package/dist/format-tables.test.js +93 -0
- package/dist/gateway-proxy-reconnect.e2e.test.js +28 -8
- package/dist/gateway-proxy.e2e.test.js +18 -18
- package/dist/git-worktree-core.js +182 -17
- package/dist/interaction-handler.js +416 -398
- package/dist/ipc-tools-plugin.js +68 -3
- package/dist/kimaki-opencode-plugin-loading.e2e.test.js +122 -58
- package/dist/kimaki-opencode-plugin.js +9 -3
- package/dist/kimaki-workspace-adaptor.js +33 -10
- package/dist/logger.js +11 -1
- package/dist/markdown.js +3 -1
- package/dist/markdown.test.js +11 -3
- package/dist/message-formatting.js +181 -51
- package/dist/message-formatting.test.js +529 -22
- package/dist/message-preprocessing.js +105 -1
- package/dist/oauth-rotation-shared.js +10 -0
- package/dist/openai-auth-plugin.js +1 -0
- package/dist/openai-auth-state.js +1 -0
- package/dist/opencode-command.js +28 -0
- package/dist/opencode-command.test.js +109 -1
- package/dist/opencode-interrupt-plugin.js +4 -0
- package/dist/opencode-interrupt-plugin.test.js +24 -0
- package/dist/opencode.js +82 -15
- package/dist/project-add.test.js +62 -0
- package/dist/question-abort-clears-dropdown.e2e.test.js +89 -0
- package/dist/question-abort-retry-text-before-dropdown.e2e.test.js +150 -0
- package/dist/question-text-before-dropdown.e2e.test.js +52 -0
- package/dist/queue-advanced-abort.e2e.test.js +8 -10
- package/dist/queue-advanced-action-buttons.e2e.test.js +8 -8
- package/dist/queue-advanced-e2e-setup.js +78 -5
- package/dist/queue-advanced-footer.e2e.test.js +60 -269
- package/dist/queue-advanced-model-switch.e2e.test.js +9 -11
- package/dist/queue-advanced-permissions-typing.e2e.test.js +15 -15
- package/dist/queue-advanced-question.e2e.test.js +32 -27
- package/dist/queue-advanced-typing-interrupt.e2e.test.js +10 -12
- package/dist/queue-advanced-typing.e2e.test.js +7 -9
- package/dist/queue-delete-message.e2e.test.js +3 -3
- package/dist/queue-drain-after-interactive-ui.e2e.test.js +5 -5
- package/dist/queue-interrupt-drain.e2e.test.js +122 -12
- package/dist/queue-question-select-drain.e2e.test.js +34 -132
- package/dist/runtime-lifecycle.e2e.test.js +21 -51
- package/dist/schema.js +35 -1
- package/dist/session-handler/event-stream-state.js +391 -50
- package/dist/session-handler/event-stream-state.test.js +736 -8
- package/dist/session-handler/model-utils.js +172 -5
- package/dist/session-handler/model-utils.test.js +445 -0
- package/dist/session-handler/opencode-session-event-log.js +30 -1
- package/dist/session-handler/thread-ingress.test.js +41 -0
- package/dist/session-handler/thread-runtime-state.js +2 -0
- package/dist/session-handler/thread-session-runtime-summary.test.js +121 -0
- package/dist/session-handler/thread-session-runtime.js +574 -299
- package/dist/session-search.js +123 -4
- package/dist/session-search.test.js +248 -1
- package/dist/session-sleep.test.js +224 -0
- package/dist/session-title-rename.test.js +37 -39
- package/dist/sleep.e2e.test.js +494 -0
- package/dist/startup-time.e2e.test.js +2 -1
- package/dist/store.js +3 -0
- package/dist/system-message.js +102 -16
- package/dist/system-message.test.js +192 -15
- package/dist/task-runner.js +96 -5
- package/dist/task-schedule.js +87 -1
- package/dist/task-schedule.test.js +149 -1
- package/dist/test-utils.js +17 -9
- package/dist/thinking-utils.js +10 -0
- package/dist/thinking-utils.test.js +35 -0
- package/dist/thread-message-queue.e2e.test.js +65 -213
- package/dist/undo-redo.e2e.test.js +17 -9
- package/dist/voice-attachment.js +23 -1
- package/dist/voice-handler.js +21 -4
- package/dist/voice-message.e2e.test.js +144 -30
- package/dist/voice-routing-input.e2e.test.js +195 -0
- package/dist/voice-routing-question.e2e.test.js +125 -0
- package/dist/voice.js +28 -8
- package/dist/voice.test.js +96 -30
- package/dist/worktree-clone-isolation.e2e.test.js +188 -0
- package/dist/worktree-lifecycle.e2e.test.js +55 -36
- package/dist/worktrees.js +226 -443
- package/dist/worktrees.test.js +435 -58
- package/dist/xai-auth-plugin.js +1 -0
- package/dist/xai-auth-state.js +1 -0
- package/package.json +8 -6
- package/skills/bump-holocron-consumers/SKILL.md +137 -0
- package/skills/critique/SKILL.md +4 -4
- package/skills/errore/SKILL.md +60 -218
- package/skills/goke/SKILL.md +150 -10
- package/skills/holocron/SKILL.md +154 -17
- package/skills/npm-package/SKILL.md +55 -35
- package/skills/profano/SKILL.md +17 -2
- package/skills/spiceflow/SKILL.md +39 -3
- package/skills/strada/SKILL.md +39 -0
- package/skills/zele/SKILL.md +19 -0
- package/src/agent-model.e2e.test.ts +287 -186
- package/src/anthropic-account-identity.ts +20 -1
- package/src/anthropic-auth-plugin.test.ts +19 -0
- package/src/anthropic-auth-plugin.ts +12 -16
- package/src/anthropic-auth-state.ts +1 -0
- package/src/bash-tool-schema-plugin.test.ts +55 -0
- package/src/bash-tool-schema-plugin.ts +46 -0
- package/src/bin.ts +78 -26
- package/src/cli-commands/maintenance.ts +59 -13
- package/src/cli-commands/project.ts +14 -35
- package/src/cli-commands/send.ts +31 -1
- package/src/cli-commands/session.ts +374 -114
- package/src/cli-commands/task.ts +34 -15
- package/src/cli-parsing.test.ts +103 -4
- package/src/cli-runner.test.ts +49 -0
- package/src/cli-runner.ts +44 -7
- package/src/cli-send-thread.e2e.test.ts +9 -11
- package/src/cli.ts +53 -0
- package/src/commands/abort.ts +6 -1
- package/src/commands/action-buttons.ts +2 -1
- package/src/commands/add-project.ts +4 -8
- package/src/commands/agent.ts +205 -29
- package/src/commands/ask-question.test.ts +48 -1
- package/src/commands/ask-question.ts +23 -33
- package/src/commands/btw.ts +40 -5
- package/src/commands/file-upload.ts +2 -1
- package/src/commands/fork-subagent.ts +2 -3
- package/src/commands/fork.ts +4 -3
- package/src/commands/last-sessions.ts +10 -4
- package/src/commands/login.ts +6 -0
- package/src/commands/merge-worktree.ts +54 -16
- package/src/commands/model-variant.ts +9 -1
- package/src/commands/model.ts +20 -9
- package/src/commands/multioauth.ts +1 -0
- package/src/commands/new-worktree.ts +138 -55
- package/src/commands/queue.ts +3 -2
- package/src/commands/resume.ts +4 -3
- package/src/commands/session.ts +94 -70
- package/src/commands/user-command.ts +6 -6
- package/src/commands/worktrees.ts +5 -12
- package/src/config.ts +18 -1
- package/src/cpu-profiler.test.ts +183 -0
- package/src/cpu-profiler.ts +293 -0
- package/src/database.ts +235 -3
- package/src/db.test.ts +293 -0
- package/src/db.ts +38 -0
- package/src/default-channel-provisioning.test.ts +155 -0
- package/src/discord-bot.ts +78 -36
- package/src/discord-command-registration.test.ts +20 -0
- package/src/discord-command-registration.ts +42 -12
- package/src/discord-utils.test.ts +176 -0
- package/src/discord-utils.ts +152 -7
- package/src/errors.ts +12 -0
- package/src/exec-async.ts +20 -11
- package/src/external-directory-permissions.e2e.test.ts +11 -7
- package/src/external-directory-project-deny.e2e.test.ts +5 -3
- package/src/external-opencode-sync.test.ts +248 -0
- package/src/external-opencode-sync.ts +122 -19
- package/src/extract-sdk-error-message.test.ts +18 -0
- package/src/file-edit-log.test.ts +287 -0
- package/src/file-edit-log.ts +283 -0
- package/src/format-tables.test.ts +101 -0
- package/src/format-tables.ts +75 -0
- package/src/gateway-proxy-reconnect.e2e.test.ts +38 -8
- package/src/gateway-proxy.e2e.test.ts +18 -17
- package/src/git-worktree-core.ts +247 -20
- package/src/interaction-handler.ts +36 -13
- package/src/ipc-tools-plugin.ts +82 -5
- package/src/kimaki-opencode-plugin-loading.e2e.test.ts +188 -97
- package/src/kimaki-opencode-plugin.ts +9 -3
- package/src/kimaki-workspace-adaptor.ts +40 -11
- package/src/logger.ts +14 -4
- package/src/markdown.test.ts +13 -3
- package/src/markdown.ts +4 -1
- package/src/message-formatting.test.ts +672 -25
- package/src/message-formatting.ts +242 -53
- package/src/message-preprocessing.ts +116 -1
- package/src/oauth-rotation-shared.ts +10 -0
- package/src/openai-auth-plugin.ts +1 -0
- package/src/openai-auth-state.ts +1 -0
- package/src/opencode-command.test.ts +140 -0
- package/src/opencode-command.ts +38 -0
- package/src/opencode-interrupt-plugin.test.ts +32 -0
- package/src/opencode-interrupt-plugin.ts +3 -0
- package/src/opencode.ts +115 -15
- package/src/project-add.test.ts +80 -0
- package/src/question-abort-clears-dropdown.e2e.test.ts +109 -0
- package/src/question-abort-retry-text-before-dropdown.e2e.test.ts +172 -0
- package/src/question-text-before-dropdown.e2e.test.ts +67 -0
- package/src/queue-advanced-abort.e2e.test.ts +8 -9
- package/src/queue-advanced-action-buttons.e2e.test.ts +8 -8
- package/src/queue-advanced-e2e-setup.ts +83 -4
- package/src/queue-advanced-footer.e2e.test.ts +67 -315
- package/src/queue-advanced-model-switch.e2e.test.ts +9 -10
- package/src/queue-advanced-permissions-typing.e2e.test.ts +15 -15
- package/src/queue-advanced-question.e2e.test.ts +36 -30
- package/src/queue-advanced-typing-interrupt.e2e.test.ts +11 -11
- package/src/queue-advanced-typing.e2e.test.ts +8 -8
- package/src/queue-delete-message.e2e.test.ts +3 -3
- package/src/queue-drain-after-interactive-ui.e2e.test.ts +5 -5
- package/src/queue-interrupt-drain.e2e.test.ts +133 -12
- package/src/queue-question-select-drain.e2e.test.ts +36 -161
- package/src/runtime-lifecycle.e2e.test.ts +21 -54
- package/src/schema.sql +15 -2
- package/src/schema.ts +37 -1
- package/src/session-handler/event-stream-state.test.ts +790 -7
- package/src/session-handler/event-stream-state.ts +568 -53
- package/src/session-handler/model-utils.test.ts +537 -0
- package/src/session-handler/model-utils.ts +281 -5
- package/src/session-handler/opencode-session-event-log.ts +31 -1
- package/src/session-handler/thread-ingress.test.ts +54 -0
- package/src/session-handler/thread-runtime-state.ts +3 -0
- package/src/session-handler/thread-session-runtime-summary.test.ts +169 -0
- package/src/session-handler/thread-session-runtime.ts +712 -358
- package/src/session-search.test.ts +281 -0
- package/src/session-search.ts +241 -7
- package/src/session-sleep.test.ts +294 -0
- package/src/session-title-rename.test.ts +54 -48
- package/src/sleep.e2e.test.ts +565 -0
- package/src/startup-time.e2e.test.ts +5 -1
- package/src/store.ts +22 -0
- package/src/system-message.test.ts +226 -15
- package/src/system-message.ts +130 -16
- package/src/task-runner.ts +138 -3
- package/src/task-schedule.test.ts +170 -0
- package/src/task-schedule.ts +141 -1
- package/src/test-utils.ts +21 -10
- package/src/thinking-utils.test.ts +46 -0
- package/src/thinking-utils.ts +21 -0
- package/src/thread-message-queue.e2e.test.ts +65 -245
- package/src/undo-redo.e2e.test.ts +17 -9
- package/src/voice-attachment.ts +29 -1
- package/src/voice-handler.ts +23 -4
- package/src/voice-message.e2e.test.ts +149 -29
- package/src/voice-routing-input.e2e.test.ts +203 -0
- package/src/voice-routing-question.e2e.test.ts +131 -0
- package/src/voice.test.ts +107 -29
- package/src/voice.ts +34 -6
- package/src/worktree-clone-isolation.e2e.test.ts +213 -0
- package/src/worktree-lifecycle.e2e.test.ts +55 -35
- package/src/worktrees.test.ts +505 -64
- package/src/worktrees.ts +257 -603
- package/src/xai-auth-plugin.ts +1 -0
- package/src/xai-auth-state.ts +1 -0
- package/dist/message-finish-field.e2e.test.js +0 -169
- package/dist/subagent-rate-limit-plugin.js +0 -184
- package/src/message-finish-field.e2e.test.ts +0 -196
- package/src/subagent-rate-limit-plugin.ts +0 -228
package/dist/system-message.js
CHANGED
|
@@ -12,6 +12,7 @@ import fs from 'node:fs';
|
|
|
12
12
|
import path from 'node:path';
|
|
13
13
|
import { getDataDir } from './config.js';
|
|
14
14
|
import { store } from './store.js';
|
|
15
|
+
import { SESSION_SEARCH_DEFAULT_DAYS } from './session-search.js';
|
|
15
16
|
/** Subfolder under the kimaki data dir for session system prompt side-channel files. */
|
|
16
17
|
export const SESSION_SYSTEM_PROMPT_DIR = 'session-system';
|
|
17
18
|
/** Stable marker present in every kimaki system prompt; used by tests and plugins. */
|
|
@@ -140,7 +141,7 @@ this feature by restarting kimaki with the \`--no-critique\` flag.
|
|
|
140
141
|
const KIMAKI_TUNNEL_INSTRUCTIONS = `
|
|
141
142
|
## running dev servers with tunnel access
|
|
142
143
|
|
|
143
|
-
|
|
144
|
+
When starting a local dev server that the Discord user should open in a browser, prefer wrapping it in \`kimaki tunnel\` so they get a public URL. Localhost URLs are useless from Discord. Invoke Kimaki directly as \`kimaki\`, not via \`npx\` or \`bunx\`.
|
|
144
145
|
|
|
145
146
|
Use \`bunx tuistory\` to run the tunnel + dev server combo in the background so it persists across commands. This is preferable to raw shell backgrounding because you can wait for real output, read logs, and interact with the running process.
|
|
146
147
|
|
|
@@ -225,6 +226,24 @@ export function isInjectedPromptMarker({ marker, }) {
|
|
|
225
226
|
}
|
|
226
227
|
return Boolean(marker.cliThreadPrompt || marker.start);
|
|
227
228
|
}
|
|
229
|
+
function getScheduledTaskSection(context) {
|
|
230
|
+
const origin = context.taskId
|
|
231
|
+
? `kimaki scheduled task #${context.taskId}`
|
|
232
|
+
: 'a one-time kimaki scheduled task';
|
|
233
|
+
const schedule = context.scheduleKind === 'cron' && context.cronExpr
|
|
234
|
+
? `Schedule: cron \`${context.cronExpr}\`${context.timezone ? ` in ${context.timezone}` : ' in UTC'}.`
|
|
235
|
+
: context.scheduleKind === 'at'
|
|
236
|
+
? 'This task runs once and does not repeat.'
|
|
237
|
+
: '';
|
|
238
|
+
return `
|
|
239
|
+
## scheduled task session
|
|
240
|
+
|
|
241
|
+
This session was started automatically by ${origin}.
|
|
242
|
+
${schedule}
|
|
243
|
+
When your run is done, just stop: the task fires again on its schedule and starts a fresh session automatically.
|
|
244
|
+
Do NOT use \`kimaki_sleep\` to wait for the next run. Sleeping pins this session and never triggers the next one; each firing of the task starts a new session on its own.
|
|
245
|
+
`;
|
|
246
|
+
}
|
|
228
247
|
function escapePromptAttribute(value) {
|
|
229
248
|
return value
|
|
230
249
|
.replaceAll('&', '&')
|
|
@@ -238,7 +257,7 @@ function escapePromptText(value) {
|
|
|
238
257
|
.replaceAll('<', '<')
|
|
239
258
|
.replaceAll('>', '>');
|
|
240
259
|
}
|
|
241
|
-
export function getOpencodePromptContext({ username, userId, sourceMessageId, sourceThreadId, repliedMessage, worktree, currentAgent, worktreeChanged, }) {
|
|
260
|
+
export function getOpencodePromptContext({ username, userId, sourceMessageId, sourceThreadId, threadName, repliedMessage, worktree, currentAgent, worktreeChanged, }) {
|
|
242
261
|
const userAttrs = [
|
|
243
262
|
...(username
|
|
244
263
|
? [` name="${escapePromptAttribute(username)}"`]
|
|
@@ -252,6 +271,9 @@ export function getOpencodePromptContext({ username, userId, sourceMessageId, so
|
|
|
252
271
|
...(sourceThreadId
|
|
253
272
|
? [` thread-id="${escapePromptAttribute(sourceThreadId)}"`]
|
|
254
273
|
: []),
|
|
274
|
+
...(threadName
|
|
275
|
+
? [` thread-name="${escapePromptAttribute(threadName)}"`]
|
|
276
|
+
: []),
|
|
255
277
|
].join('');
|
|
256
278
|
const repliedMessageXml = repliedMessage
|
|
257
279
|
? `This message was a reply to message
|
|
@@ -280,7 +302,7 @@ ${escapePromptText(repliedMessage.text)}
|
|
|
280
302
|
// model concatenates message parts.
|
|
281
303
|
return `${sections.join('\n\n')}\n`;
|
|
282
304
|
}
|
|
283
|
-
export function getOpencodeSystemMessage({ sessionId, channelId, guildId, threadId, channelTopic, agents, userId, parentSessionId, }) {
|
|
305
|
+
export function getOpencodeSystemMessage({ sessionId, channelId, guildId, threadId, channelTopic, agents, userId, parentSessionId, scheduledTask, }) {
|
|
284
306
|
const userArg = ` --user '${userId || '<discord-user-id>'}'`;
|
|
285
307
|
const parentSessionArg = ` --parent-session ${sessionId}`;
|
|
286
308
|
// Prefer thread ID for cross-machine compatibility; fall back to session ID.
|
|
@@ -304,6 +326,12 @@ export function getOpencodeSystemMessage({ sessionId, channelId, guildId, thread
|
|
|
304
326
|
return `
|
|
305
327
|
The user is reading your messages from inside Discord, via kimaki.dev
|
|
306
328
|
|
|
329
|
+
## Discord output
|
|
330
|
+
|
|
331
|
+
Be concise. Do not narrate between tool calls. Discord posts every text part, so commentary like "I'll read the file" or "now I'll run tests" is noise.
|
|
332
|
+
Do not output text until you are ready to give the user the final answer for this turn. Tool calls can run with no preceding text.
|
|
333
|
+
Exceptions: when a tool requires user-visible text first (\`question\`, \`kimaki_action_buttons\`, \`kimaki_file_upload\`, \`kimaki_sleep\`), write that required text, then call the tool.
|
|
334
|
+
|
|
307
335
|
## bash tool
|
|
308
336
|
|
|
309
337
|
When calling the bash tool, always include these extra fields alongside \`command\`:
|
|
@@ -320,12 +348,12 @@ interface BashToolInput {
|
|
|
320
348
|
}
|
|
321
349
|
\`\`\`
|
|
322
350
|
|
|
323
|
-
\`description\` is shown
|
|
351
|
+
\`description\` is shown in Discord when the bash command is longer than 50 characters.
|
|
324
352
|
\`hasSideEffect\` distinguishes essential bash calls from read-only ones in low-verbosity mode.
|
|
325
353
|
|
|
326
354
|
Your current OpenCode session ID is: ${sessionId}${channelId ? `\nYour current Discord channel ID is: ${channelId}` : ''}${threadId ? `\nYour current Discord thread ID is: ${threadId}` : ''}${guildId ? `\nYour current Discord guild ID is: ${guildId}` : ''}${parentSessionContext}
|
|
327
355
|
|
|
328
|
-
Per-turn Discord metadata like the current user
|
|
356
|
+
Per-turn Discord metadata like the current user, current agent, and Discord thread title is delivered in synthetic user message parts.
|
|
329
357
|
|
|
330
358
|
## permissions
|
|
331
359
|
|
|
@@ -348,6 +376,7 @@ Do not restart the bot unless the user explicitly asks for it.
|
|
|
348
376
|
|
|
349
377
|
## debugging kimaki issues
|
|
350
378
|
|
|
379
|
+
ALWAYS read https://kimaki.dev/docs/guides/report-bugs first before submitting any issue to Kimaki. That page is the source of truth for exporting session jsonl, sharing evidence in a gist, and filing bugs. Never open a pull request on remorses/kimaki unless remorses asked for one in a comment on the issue.
|
|
351
380
|
If there are internal kimaki issues (sessions not responding, bot errors, unexpected behavior), read the log file at \`${getDataDir()}/kimaki.log\`. This file contains detailed logs of all bot activity including session creation, event handling, errors, and API calls. The log file is reset every time the bot restarts, so it only contains logs from the current run.
|
|
352
381
|
|
|
353
382
|
## uploading files to discord
|
|
@@ -356,6 +385,8 @@ To upload files to the Discord thread (images, screenshots, long files that woul
|
|
|
356
385
|
|
|
357
386
|
kimaki upload-to-discord --session ${sessionId} <file1> [file2] ...
|
|
358
387
|
|
|
388
|
+
NEVER show images with markdown like \`\` or \`\`. Discord does not render local markdown images. ALWAYS upload them with \`kimaki upload-to-discord\` so they appear as real Discord attachments. Do this for every screenshot, generated image, and visual step the user should see.
|
|
389
|
+
|
|
359
390
|
## generating audio from text
|
|
360
391
|
|
|
361
392
|
When the user asks you to generate audio of some text so they can listen instead of reading, use \`kimaki tts\` to create a speech file and \`kimaki upload-to-discord\` to send it to the thread. Only use this when the user explicitly asks for audio.
|
|
@@ -377,9 +408,18 @@ see --help for options like voice, speed, etc.
|
|
|
377
408
|
To ask the user to upload files from their device, use \`kimaki_file_upload\`. This shows a native file picker dialog in Discord. The files are downloaded to the project's \`uploads/\` directory and the tool returns the local file paths.
|
|
378
409
|
You MUST call \`kimaki_file_upload\` LAST, after ALL text.
|
|
379
410
|
|
|
411
|
+
## sleeping the session
|
|
412
|
+
|
|
413
|
+
Use \`kimaki_sleep\` to pause this session for hours or days, then continue when the time is reached. The sleep is stored in SQLite and survives bot restarts.
|
|
414
|
+
Pass either \`duration\` (\`30s\`, \`2h\`, \`1d\`) or \`until\` (UTC ISO ending with \`Z\`, example \`2026-08-20T09:00:00Z\`).
|
|
415
|
+
You MUST call \`kimaki_sleep\` LAST, after ALL text. Do not call more tools after it.
|
|
416
|
+
A new user message cancels the sleep. If you still need to wake later after answering, call \`kimaki_sleep\` again with \`until\` set to the original UTC time.
|
|
417
|
+
The tool result is not a wake. After it succeeds, write one short line that you are waiting, then stop. Do not continue the wait reason and do not pretend time has passed.
|
|
418
|
+
Wake is a later Discord message that starts with \`Woke after sleeping until\`. Only then continue the wait reason.
|
|
419
|
+
${scheduledTask ? getScheduledTaskSection(scheduledTask) : ''}
|
|
380
420
|
## archiving the current thread
|
|
381
421
|
|
|
382
|
-
To archive the current Discord thread (hide it from sidebar)
|
|
422
|
+
To archive the current Discord thread (hide it from sidebar) without stopping the session, run:
|
|
383
423
|
|
|
384
424
|
kimaki session archive ${archiveTarget}
|
|
385
425
|
|
|
@@ -394,6 +434,17 @@ kimaki session abort <session_id>
|
|
|
394
434
|
This stops the AI from processing but keeps the thread visible in Discord.
|
|
395
435
|
Different from \`kimaki session archive\` which hides the thread.
|
|
396
436
|
|
|
437
|
+
## updating the session title
|
|
438
|
+
|
|
439
|
+
When the session scope or goal changed from the first message, update the title:
|
|
440
|
+
|
|
441
|
+
kimaki session title 'Short title' --session ${sessionId}
|
|
442
|
+
|
|
443
|
+
The current Discord thread title is in the per-turn \`<discord-user thread-name="..." />\` metadata.
|
|
444
|
+
This updates the OpenCode title. Discord follows automatically.
|
|
445
|
+
Do not retitle every turn. Discord rate-limits thread renames.
|
|
446
|
+
Keep titles short. Do not add emoji. Do not copy ⬦, btw:, or Fork: prefixes.
|
|
447
|
+
|
|
397
448
|
## discord user mentions
|
|
398
449
|
|
|
399
450
|
Prefer Discord user IDs for mentions. Discord bots cannot ping by @name; use \`<@userId>\` in message text or pass the ID to \`--user\`.
|
|
@@ -491,13 +542,13 @@ kimaki send --thread <thread_id> --prompt '/<agentname>-agent' --agent <current_
|
|
|
491
542
|
Use \`--send-at\` to schedule a one-time or recurring task:
|
|
492
543
|
|
|
493
544
|
kimaki send --channel ${channelId} --prompt 'Reminder: review open PRs' --send-at '2026-03-01T09:00:00Z' --agent <current_agent>${parentSessionArg}${userArg}
|
|
494
|
-
kimaki send --channel ${channelId} --prompt 'Run weekly test suite and summarize failures' --send-at '0 9 * * 1' --agent <current_agent>${parentSessionArg}
|
|
545
|
+
kimaki send --channel ${channelId} --prompt 'Run weekly test suite and summarize failures' --send-at '0 9 * * 1' --agent <current_agent>${parentSessionArg}
|
|
495
546
|
|
|
496
547
|
Use \`--pre-run '<command>'\` to check whether a scheduled task should start. Kimaki runs the command in the project directory. Exit code 0 starts the session and appends stdout to the prompt. Any other exit code skips that occurrence. Command output is written to the Kimaki log.
|
|
497
548
|
|
|
498
549
|
Scheduled tasks do not overlap by default. Add \`--allow-concurrency\` only when concurrent sessions from the same task are safe.
|
|
499
550
|
|
|
500
|
-
|
|
551
|
+
Pass \`--user\` when the user should see or act on the thread. Omit \`--user\` for routine autonomous work (digests, monitors, housekeeping) so the thread does not appear in the user's Discord sidebar. Discord only shows a thread in the left sidebar to its members. Without \`--user\`, kimaki does not ensure anyone is a member. This applies to \`--channel\` and \`--thread\` scheduling alike.
|
|
501
552
|
|
|
502
553
|
ALL scheduling is in UTC. Dates must be UTC ISO format ending with \`Z\`. Cron expressions also fire in UTC (e.g. \`0 9 * * 1\` means 9:00 UTC every Monday).
|
|
503
554
|
When the user specifies a time without a timezone, ask them to confirm their timezone or the UTC equivalent. Never guess the user's timezone.
|
|
@@ -509,14 +560,14 @@ When the user specifies a time without a timezone, ask them to confirm their tim
|
|
|
509
560
|
- \`--pre-run\` to start only when a project command exits with code 0
|
|
510
561
|
- \`--allow-concurrency\` to permit overlapping runs from the same task
|
|
511
562
|
- \`--parent-session\` to pass this session as parent of the scheduled child
|
|
512
|
-
- \`--user\` to add a specific user to the scheduled thread
|
|
563
|
+
- \`--user\` to add a specific user to the scheduled thread. Omit this for quiet autonomous work
|
|
513
564
|
|
|
514
565
|
\`--wait\` is incompatible with \`--send-at\` because scheduled tasks run in the future.
|
|
515
566
|
|
|
516
567
|
Keep scheduled task prompts **short**. The prompt text becomes the first message in the Discord thread, so long prompts clutter the channel. Instead of inlining the full task description in \`--prompt\`, write a markdown file in the project's \`tasks/\` folder and reference it:
|
|
517
568
|
|
|
518
569
|
\`\`\`bash
|
|
519
|
-
kimaki send --channel ${channelId} --prompt 'Read tasks/weekly-test-suite.md and follow instructions' --send-at '0 9 * * 1' --agent <current_agent>${parentSessionArg}
|
|
570
|
+
kimaki send --channel ${channelId} --prompt 'Read tasks/weekly-test-suite.md and follow instructions' --send-at '0 9 * * 1' --agent <current_agent>${parentSessionArg}
|
|
520
571
|
\`\`\`
|
|
521
572
|
|
|
522
573
|
The task file should contain all the detail: goal, constraints, expected output, completion criteria. Use this frontmatter format:
|
|
@@ -535,7 +586,7 @@ For simple reminders and notifications (\`--notify-only\`), inline the prompt di
|
|
|
535
586
|
Notification strategy:
|
|
536
587
|
- NEVER use \`@username\` (e.g. \`@Tommy\`) directly in task prompts. The prompt text becomes the first message in the thread, so a raw \`@\` mention triggers an actual Discord ping every time the task fires. Instead, wrap it in inline code like \`\\\`@Tommy\\\`\`, or use Discord user ID mentions like \`<@USER_ID>\` only in the body of the prompt where the agent will process it, not in the opening line.
|
|
537
588
|
- If a task needs user attention, add "mention the user via Discord user ID when task requires user review" in the task md file.
|
|
538
|
-
- With \`--user\`, the user is added to the thread and receives thread-level notifications.
|
|
589
|
+
- With \`--user\`, the user is added to the thread and receives thread-level notifications. Omit \`--user\` when the work should stay out of the sidebar.
|
|
539
590
|
- If a scheduled task completes with no actionable result, archive the session: \`kimaki session archive ${archiveTarget}\`
|
|
540
591
|
|
|
541
592
|
Manage scheduled tasks with:
|
|
@@ -544,7 +595,7 @@ kimaki task list
|
|
|
544
595
|
kimaki task edit <id> --prompt "new prompt" [--send-at "new schedule"] [--pre-run "command"] [--allow-concurrency true|false] [--user "<discord-user-id>"] [--model "provider/model"] [--agent "<agent>"]
|
|
545
596
|
kimaki task delete <id>
|
|
546
597
|
|
|
547
|
-
\`kimaki task list\` prints \`userId\`, \`agent\`, and \`model\` columns. A \`-\` in \`userId\` means nobody is added to the thread when that task fires, so the user may never see it.
|
|
598
|
+
\`kimaki task list\` prints \`userId\`, \`agent\`, and \`model\` columns. A \`-\` in \`userId\` means nobody is added to the thread when that task fires, so the user may never see it. Add a user with \`kimaki task edit <id> --user '<discord-user-id>'\`. Clear a stored user with \`kimaki task edit <id> --user ''\`. Change model or agent in place with \`--model\` / \`--agent\` (empty string clears the override). Do not read SQLite or recreate the task just to swap model.
|
|
548
599
|
|
|
549
600
|
\`kimaki session list\` also shows if a session was started by a scheduled \`delay\` or \`cron\` task, including task ID when available.
|
|
550
601
|
|
|
@@ -622,15 +673,22 @@ To list all sessions in this project (shows which were started via kimaki):
|
|
|
622
673
|
kimaki session list
|
|
623
674
|
kimaki session list --json # machine-readable output
|
|
624
675
|
kimaki session list --project /path/to/project # specific project
|
|
676
|
+
|
|
677
|
+
# List only in-progress sessions. Exit status is 1 when none remain.
|
|
678
|
+
kimaki session list --active
|
|
625
679
|
\`\`\`
|
|
626
680
|
|
|
627
|
-
|
|
681
|
+
Titles prefixed with \`btw:\` are side sessions that answer a related user question in parallel. They are not duplicate sessions of the main task.
|
|
682
|
+
|
|
683
|
+
To search past sessions (supports plain text or /regex/flags). Defaults to this project and the last ${SESSION_SEARCH_DEFAULT_DAYS} days. Use \`--days 0\` for all time. Use \`--all\` to search every locally registered project:
|
|
628
684
|
|
|
629
685
|
\`\`\`bash
|
|
630
686
|
kimaki session search "auth timeout"
|
|
687
|
+
kimaki session search "auth timeout" --days 0
|
|
631
688
|
kimaki session search "/error\\s+42/i"
|
|
632
689
|
kimaki session search "rate limit" --project /path/to/project
|
|
633
690
|
kimaki session search "/panic|crash/i" --channel <channel_id>
|
|
691
|
+
kimaki session search "auth timeout" --all
|
|
634
692
|
\`\`\`
|
|
635
693
|
|
|
636
694
|
To read a session's full conversation as markdown, pipe to a file and grep it to avoid wasting context.
|
|
@@ -642,6 +700,29 @@ kimaki session read <sessionId> > ./tmp/session.md 2>/dev/null
|
|
|
642
700
|
|
|
643
701
|
Then use grep/read tools on the file to find what you need.
|
|
644
702
|
|
|
703
|
+
### who edited a file
|
|
704
|
+
|
|
705
|
+
To find the session that last edited a file, run:
|
|
706
|
+
|
|
707
|
+
\`\`\`bash
|
|
708
|
+
kimaki session editors src/foo.ts
|
|
709
|
+
kimaki session editors src/foo.ts --json
|
|
710
|
+
\`\`\`
|
|
711
|
+
|
|
712
|
+
Output is newest first. Each row has:
|
|
713
|
+
|
|
714
|
+
- **session ID** (\`ses_xxx\`)
|
|
715
|
+
- **title** (Discord thread name, so you can tell what that session was doing)
|
|
716
|
+
- **time ago** (when that session last edited the file)
|
|
717
|
+
|
|
718
|
+
Use this before a commit when this session did not edit the file. Put the original session ID as the last line of the commit message:
|
|
719
|
+
|
|
720
|
+
\`\`\`
|
|
721
|
+
Session: ses_xxx
|
|
722
|
+
\`\`\`
|
|
723
|
+
|
|
724
|
+
If this session edited the file, use this session ID instead. If several files come from different sessions, split the commit by session. Do not attribute another session's edits to this one.
|
|
725
|
+
|
|
645
726
|
## cross-project commands
|
|
646
727
|
|
|
647
728
|
When the user references another project by name, run \`kimaki project list\` to find its directory path and channel ID. Then read files, search code, or run commands directly in that directory. If the project is not listed, use \`kimaki project add /path/to/repo\` to register it and create a Discord channel for it. Do not add subfolders of an existing project — only add root project directories.
|
|
@@ -708,7 +789,7 @@ Use \`--wait\` to block until a session completes and print its full conversatio
|
|
|
708
789
|
|
|
709
790
|
When the user asks you to wait for an existing session, run \`kimaki session wait <session_id>\` yourself via Bash, then continue from the printed session markdown. Do not tell the user to run the command.
|
|
710
791
|
|
|
711
|
-
IMPORTANT: if you run \`kimaki send --wait
|
|
792
|
+
IMPORTANT: if you run \`kimaki send --wait\`, \`kimaki session wait <session_id>\`, or the active-session wait loop via the Bash tool, you must set the Bash tool \`timeout\` to **20 minutes or more** (example: \`timeout: 1_500_000\`). Otherwise the tool will terminate early (default is 2 minutes) and you won't see long sessions.
|
|
712
793
|
|
|
713
794
|
If your Bash tool timeout triggers anyway, fall back to reading the session output from disk:
|
|
714
795
|
|
|
@@ -723,9 +804,14 @@ kimaki send --thread <thread_id> --prompt 'Run the tests' --wait --agent <curren
|
|
|
723
804
|
|
|
724
805
|
# Wait for a session that was already started elsewhere
|
|
725
806
|
kimaki session wait <session_id>
|
|
807
|
+
|
|
808
|
+
# Wait until every other in-progress session in this project finishes
|
|
809
|
+
while kimaki session list --active --exclude ${sessionId}; do sleep 5; done
|
|
726
810
|
\`\`\`
|
|
727
811
|
|
|
728
|
-
|
|
812
|
+
\`session list --active\` exits with status 0 while it finds active sessions and status 1 when none remain. Exclude the current session in a wait loop so the loop does not wait for itself.
|
|
813
|
+
|
|
814
|
+
\`session wait\` exits with the session markdown on stdout once the model finishes responding.
|
|
729
815
|
|
|
730
816
|
Use \`--wait\` when you need to:
|
|
731
817
|
- **Fix a bug in another project** before continuing here (e.g. fix a dependency, then resume)
|
|
@@ -838,7 +924,7 @@ You MUST write ALL user-visible text FIRST.
|
|
|
838
924
|
You MUST call \`question\` LAST, after ALL text parts.
|
|
839
925
|
NEVER call \`question\` before your text. Discord will hide the message.
|
|
840
926
|
|
|
841
|
-
The same rule applies to \`kimaki_action_buttons\` and \`
|
|
927
|
+
The same rule applies to \`kimaki_action_buttons\`, \`kimaki_file_upload\`, and \`kimaki_sleep\`.
|
|
842
928
|
You MUST call them LAST, after ALL text.
|
|
843
929
|
|
|
844
930
|
ALWAYS use \`question\` when you ask the user a question. Do not write a numbered list in plain text.
|