sdk: update readme, bump version, handle passed in apiKey

Author: jahooma

sdk/README.md

@@ -26,97 +26,40 @@ npm install @codebuff/sdk
 ```typescript
 import * as fs from 'fs'
 import * as os from 'os'
+import { CodebuffClient } from '@codebuff/sdk'
 
-import { WebSocketHandler, getInitialSessionState } from '@codebuff/sdk'
+// Available after running `codebuff login`
+const apiKey = JSON.parse(
+  fs
+    .readFileSync(os.homedir() + '/.config/manicode/credentials.json')
+    .toString(),
+).default.authToken
 
-const client = new WebSocketHandler({
-  onWebsocketError: (error) => {
-    console.log({ error }, 'onWebsocketError')
-  },
-  onWebsocketReconnect: () => {
-    console.log('onWebsocketReconnect')
-  },
-  onResponseError: async (error) => {
-    console.log({ error }, 'onResponseError')
-  },
-  onRequestReconnect: async () => {
-    console.log('onRequestReconnect')
-  },
-  readFiles: async (input) => {
-    console.log({ input }, 'readFiles')
-    return {}
-  },
-  handleToolCall: async ({
-    type,
-    toolName,
-    requestId,
-    userInputId,
-    args,
-    timeout,
-  }) => {
-    console.log(
-      { type, toolName, requestId, userInputId, args, timeout },
-      'handleToolCall',
-    )
-    return { success: true, toolCallResult: 'asdf' }
-  },
-  onCostResponse: async (action) => {
-    console.log({ action }, 'onCostResponse')
-  },
-  onUsageResponse: async (action) => {
-    console.log({ action }, 'onUsageResponse')
-  },
-  onResponseChunk: async (action) => {
-    console.log({ action }, 'onResponseChunk')
-  },
-  onSubagentResponseChunk: async (action) => {
-    console.log({ action }, 'onSubagentResponseChunk')
-  },
-  onPromptResponse: async (response) => {
-    console.log({ response }, 'onPromptResponse')
-  },
-  // Available after running `codebuff login`
-  apiKey: JSON.parse(
-    fs
-      .readFileSync(os.homedir() + '/.config/manicode/credentials.json')
-      .toString(),
-  ).default.authToken,
+const client = new CodebuffClient({
+  apiKey,
+  cwd: process.cwd(),
+  onError: (e) => console.error('Codebuff error:', e.message),
+  // Optional: Override the implementation of specific tools.
+  overrideTools: {},
 })
 
-console.log('connecting')
-await client.connect()
-console.log('connected')
-client.sendInput({
-  prompt: 'can you run echo "hi" for me?',
-  promptId: 'some-prompt-id-12345',
-  costMode: 'normal',
-  sessionState: getInitialSessionState({
-    projectRoot: os.homedir() + '/github/codebuff',
-    cwd: os.homedir() + '/github/codebuff',
-    fileTree: [],
-    fileTokenScores: {},
-    tokenCallers: {},
-    knowledgeFiles: {},
-    userKnowledgeFiles: {},
-    agentTemplates: {},
-    gitChanges: {
-      status: '',
-      diff: '',
-      diffCached: '',
-      lastCommitMessages: '',
-    },
-    changesSinceLastChat: {},
-    shellConfigFiles: {},
-    systemInfo: {
-      platform: process.platform,
-      shell: 'bash',
-      nodeVersion: process.version,
-      arch: process.arch,
-      homedir: os.homedir() + '/github/codebuff',
-      cpus: 16,
-    },
-  }),
-  toolResults: [],
+// Single run
+const run1 = await client.run({
+  agent: 'base',
+  prompt: 'Add console.log("Hello from Codebuff") to src/index.ts',
+})
+
+// Continue same session with follow‑up
+const run2 = await client.run({
+  agent: 'base',
+  prompt: 'Create a basic test file for it',
+  previousRun: run1,
+
+  // Stream events (optional)
+  handleEvent: (event) => {
+    // event includes streamed updates like assistant messages and tool calls
+    console.log('event:', event)
+  },
 })
 ```
 

sdk/package.json

@@ -2,7 +2,7 @@
   "name": "@codebuff/sdk",
   "private": false,
   "access": "public",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Official SDK for Codebuff — AI coding agent & framework",
   "license": "MIT",
   "type": "module",

sdk/src/client.ts

@@ -19,6 +19,8 @@ import { getFiles } from './tools/read-files'
 type ClientToolName = 'write_file' | 'run_terminal_command'
 
 export type CodebuffClientOptions = {
+  // Provide an API key or set the CODEBUFF_API_KEY environment variable.
+  apiKey?: string
   cwd: string
   onError: (error: { message: string }) => void
   overrideTools: Partial<
@@ -57,7 +59,7 @@ export class CodebuffClient {
     { resolve: (response: any) => void; reject: (error: any) => void }
   > = {}
 
-  constructor({ cwd, onError, overrideTools }: CodebuffClientOptions) {
+  constructor({ apiKey, cwd, onError, overrideTools }: CodebuffClientOptions) {
     // TODO: download binary automatically
     const isWindows = process.platform === 'win32'
     if (
@@ -69,17 +71,17 @@ export class CodebuffClient {
         `Could not find ${CODEBUFF_BINARY} in PATH. Please run "npm i -g codebuff" to install codebuff.`,
       )
     }
-    if (!process.env[API_KEY_ENV_VAR]) {
+    const foundApiKey = apiKey ?? process.env[API_KEY_ENV_VAR]
+    if (!foundApiKey) {
       throw new Error(
-        `Codebuff API key not found. Please set the ${API_KEY_ENV_VAR} environment variable.`,
+        `Codebuff API key not found. Please provide an apiKey in the constructor of CodebuffClient or set the ${API_KEY_ENV_VAR} environment variable.`,
       )
     }
-    const apiKey = process.env[API_KEY_ENV_VAR]
 
     this.cwd = cwd
     this.overrideTools = overrideTools
     this.websocketHandler = new WebSocketHandler({
-      apiKey,
+      apiKey: foundApiKey,
       onWebsocketError: (error) => {
         onError({ message: error.message })
       },
@@ -130,7 +132,7 @@ export class CodebuffClient {
     prompt,
     params,
     handleEvent,
-    previousState,
+    previousRun,
     allFiles,
     knowledgeFiles,
     agentConfig,
@@ -140,7 +142,7 @@ export class CodebuffClient {
     prompt: string
     params?: Record<string, any>
     handleEvent?: (event: PrintModeEvent) => void
-    previousState?: RunState
+    previousRun?: RunState
     allFiles?: Record<string, string>
     knowledgeFiles?: Record<string, string>
     agentConfig?: Record<string, any>
@@ -150,14 +152,14 @@ export class CodebuffClient {
 
     const promptId = Math.random().toString(36).substring(2, 15)
     const sessionState =
-      previousState?.sessionState ??
+      previousRun?.sessionState ??
       initialSessionState(this.cwd, {
         knowledgeFiles,
         agentConfig,
         allFiles,
         maxAgentSteps,
       })
-    const toolResults = previousState?.toolResults ?? []
+    const toolResults = previousRun?.toolResults ?? []
     if (handleEvent) {
       this.promptIdToHandleEvent[promptId] = handleEvent
     }