@augmentcode/auggie-sdk 0.1.2 → 0.1.4

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Augment Code Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -36,10 +36,9 @@ pnpm add /path/to/auggie-sdk
 import { Auggie } from "@augmentcode/auggie-sdk";
 
 async function main() {
-  // Create and initialize Auggie (automatically connects and creates a session)
+  // Create and initialize Auggie instance
   const client = await Auggie.create({
     model: "sonnet4.5",     // Optional: haiku4.5, opus4.1, sonnet4.5, sonnet4
-    debug: false,           // Optional: enable debug logging
     apiKey: "your-api-key", // Optional: API key for authentication
     apiUrl: "https://api.augmentcode.com", // Optional: API URL
   });
@@ -51,7 +50,7 @@ async function main() {
     });
 
     // Send a prompt
-    const response = await client.sendPrompt("What files are in the current directory?");
+    const response = await client.prompt("What files are in the current directory?");
     console.log("Response:", response);
 
     // Close the connection
@@ -126,14 +125,14 @@ const weatherTool = tool({
 });
 
 async function main() {
-  // Pass tools when creating the instance
+  // Create the instance with tools
   const client = await Auggie.create({
     model: "sonnet4.5",
-    toolsMap: { weather_tool: weatherTool }
+    toolsMap: { weather_tool: weatherTool },
   });
 
   try {
-    const response = await client.sendPrompt("What's the weather in San Francisco?");
+    const response = await client.prompt("What's the weather in San Francisco?");
     console.log(response);
 
     await client.close();
@@ -152,10 +151,10 @@ When the agent uses tools (like file operations, web searches, etc.), you can ch
 
 ```typescript
 // Get all agent responses (default behavior)
-const fullResponse = await client.sendPrompt("List all TypeScript files in this project");
+const fullResponse = await client.prompt("List all TypeScript files in this project");
 
 // Get only the final response after tool calls
-const finalAnswer = await client.sendPrompt(
+const finalAnswer = await client.prompt(
   "List all TypeScript files in this project",
   { isAnswerOnly: true }
 );
@@ -209,7 +208,6 @@ const client = await Auggie.create({
   auggiePath: "/path/to/auggie",
   workspaceRoot: "/path/to/workspace",
   model: "sonnet4.5",
-  debug: true,
   allowIndexing: true,
   apiKey: "your-api-key",  // Optional
   apiUrl: "https://api.augmentcode.com",  // Optional
@@ -226,40 +224,28 @@ const client = await Auggie.create({
 static async create(options?: AuggieOptions): Promise<Auggie>
 ```
 
-Creates a new Auggie instance and automatically connects and initializes a session.
+Creates and initializes a new Auggie instance. This method automatically connects to the ACP server and creates a session before returning.
 
 **Options:**
 - `auggiePath?: string` - Path to the Auggie executable (default: "auggie")
 - `workspaceRoot?: string` - Working directory for the Auggie process (default: `process.cwd()`)
-- `debug?: boolean` - Enable debug logging (default: false)
 - `model?: "haiku4.5" | "opus4.1" | "sonnet4.5" | "sonnet4"` - Model to use (default: "haiku4.5")
 - `allowIndexing?: boolean` - Allow codebase indexing (default: true)
 - `toolsMap?: Record<string, Tool>` - Custom tools to provide to Auggie (optional)
 - `apiKey?: string` - API key for authentication (optional, sets AUGMENT_API_TOKEN)
 - `apiUrl?: string` - API URL for authentication (optional, sets AUGMENT_API_URL)
 
-#### Methods
-
-##### `connect(): Promise<void>`
-
-Launches Auggie in ACP mode and establishes a connection. (Called automatically by `create()`)
-
-##### `createSession(toolsMap?: Record<string, Tool>): Promise<string>`
+When `toolsMap` is provided, an MCP server is automatically started and connected to the session.
 
-Creates a new session. (Called automatically by `create()`)
+**Note:** The constructor is private. Always use `Auggie.create()` to instantiate the class.
 
-Creates a new conversation session with the agent.
-
-- `toolsMap`: Optional map of tool names to AI SDK Tool objects
-- Returns: Session ID
-
-When tools are provided, an MCP server is automatically started and connected to the session.
+#### Methods
 
-##### `sendPrompt(prompt: string, options?: { isAnswerOnly?: boolean }): Promise<string>`
+##### `prompt(message: string, options?: { isAnswerOnly?: boolean }): Promise<string>`
 
 Sends a prompt to the agent and waits for completion.
 
-- `prompt`: The text prompt to send
+- `message`: The text prompt to send
 - `options.isAnswerOnly`: Optional boolean (default: `false`). When set to `true`, returns only the final response after all tool calls complete. When `false` or omitted, returns all agent message chunks including any intermediate responses.
 - Returns: The accumulated text response from the agent
 
@@ -334,8 +320,7 @@ const weatherTool = tool({
 async function main() {
   const client = await Auggie.create({
     model: "sonnet4.5",
-    debug: true,
-    toolsMap: { weather_tool: weatherTool }
+    toolsMap: { weather_tool: weatherTool },
   });
 
   try {
@@ -357,7 +342,7 @@ async function main() {
       }
     });
 
-    const response = await client.sendPrompt(
+    const response = await client.prompt(
       "What's the weather in Tokyo?",
       { isAnswerOnly: true }
     );
@@ -378,7 +363,7 @@ main();
 ```typescript
 try {
   const client = await Auggie.create();
-  await client.sendPrompt("Hello!");
+  await client.prompt("Hello!");
   await client.close();
 } catch (error) {
   if (error instanceof Error) {

package/package.json

@@ -1,39 +1,37 @@
 {
-  "name": "@augmentcode/auggie-sdk",
-  "version": "0.1.2",
-  "description": "TypeScript SDK for Auggie",
-  "type": "module",
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "tsc --project tsconfig.build.json",
-    "dev": "bun ./examples/dev.ts",
-    "silent": "bun ./examples/silent.ts",
-    "prepare": "husky"
-  },
-  "devDependencies": {
-    "@biomejs/biome": "2.3.4",
-    "@types/bun": "latest",
-    "husky": "^9.1.7",
-    "ultracite": "6.3.0"
-  },
-  "peerDependencies": {
-    "typescript": "^5"
-  },
-  "dependencies": {
-    "@agentclientprotocol/sdk": "^0.5.1",
-    "@mastra/mcp": "^0.14.1",
-    "ai": "^5.0.86",
-    "zod": "^4.1.12"
-  }
+	"name": "@augmentcode/auggie-sdk",
+	"version": "0.1.4",
+	"description": "TypeScript SDK for Auggie",
+	"type": "module",
+	"main": "./dist/index.js",
+	"module": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js"
+		}
+	},
+	"files": ["dist"],
+	"scripts": {
+		"build": "tsc --project tsconfig.build.json",
+		"dev": "bun ./examples/dev.ts",
+		"silent": "bun ./examples/silent.ts",
+		"prepare": "husky"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "2.3.4",
+		"@types/bun": "latest",
+		"husky": "^9.1.7",
+		"ultracite": "6.3.0"
+	},
+	"peerDependencies": {
+		"typescript": "^5"
+	},
+	"dependencies": {
+		"@agentclientprotocol/sdk": "^0.5.1",
+		"@mastra/mcp": "^0.14.1",
+		"ai": "^5.0.86",
+		"zod": "^4.1.12"
+	}
 }