ai-code-agents 0.1.0-beta.1 → 0.2.0

package/README.md

@@ -13,12 +13,18 @@ A TypeScript SDK for creating AI agents that interact with sandboxed code execut
 
 ## Installation
 
-You will need Node.js 20+ and npm or another package manager installed on your local machine.
+You will need:
+
+- Node.js 20+
+- `npm` or another package manager
+- AI SDK v6+ and zod v4+ (see below)
 
 ```bash
-npm install ai-code-agents
+npm install ai-code-agents ai zod
 ```
 
+To explore the SDK via a command-line interface, see [`@ai-code-agents/cli`](https://www.npmjs.com/package/@ai-code-agents/cli).
+
 ## Quick Start
 
 ```typescript
@@ -33,14 +39,15 @@ const environment = createEnvironment('docker', {
 
 // Create an agent with all tools
 const agent = createCodeAgent({
-  model: openai('gpt-4'),
+  model: openai('gpt-5'),
   environment,
   environmentToolsDefinition: 'all',
   maxSteps: 10,
+  logStep: (log: string) => console.log(log),
 });
 
 // Run the agent
-const result = await agent.execute({
+const result = await agent.generate({
   prompt: 'Create a simple Node.js HTTP server in server.js',
 });
 
@@ -53,23 +60,27 @@ console.log(result.text);
 
 Environments provide sandboxed execution contexts for agents. All tools are built against environment interfaces, ensuring complete interoperability.
 
-**Currently Available:**
+**Built-in:**
 
 - `docker` - Docker container environments
 - `node-filesystem` - Node.js filesystem operations (read-only recommended)
 - `unsafe-local` - Local filesystem with command execution (development only)
 - `mock-filesystem` - In-memory filesystem for testing
 
+**Additional:**
+
+- [`@ai-code-agents/just-bash`](https://www.npmjs.com/package/@ai-code-agents/just-bash) - Simulated bash environments using "just-bash"
+- [`@ai-code-agents/vercel-sandbox`](https://www.npmjs.com/package/@ai-code-agents/vercel-sandbox) - Vercel sandbox environments
+
 **Planned:**
 
 - `e2b` - E2B cloud sandboxes
-- `vercel-sandbox` - Vercel sandbox environments
 
 ### Tools
 
 Tools enable agents to interact with their environments. Each tool has a well-defined purpose with comprehensive input/output validation.
 
-**Currently Available:**
+**Built-in:**
 
 - `read_file` - Read file contents
 - `write_file` - Write or create files
@@ -97,14 +108,7 @@ Tools enable agents to interact with their environments. Each tool has a well-de
 
 ### Agent Integrations
 
-**Currently Available:**
-
-- [Vercel AI SDK](https://ai-sdk.dev/) - Integration with AI SDK agents
-
-**Planned:**
-
-- [Mastra](https://mastra.ai/) - Integration with Mastra agents
-- [AI SDK Tools](https://ai-sdk-tools.dev/) - Integration with AI SDK Tools agents
+The agent infrastructure from the AI SDK is used by default. The `createCodeAgent` function will return an instance of `ToolLoopAgent`.
 
 ## Usage Examples
 
@@ -119,7 +123,7 @@ const environment = createEnvironment('unsafe-local', {
 });
 
 const agent = createCodeAgent({
-  model: anthropic('claude-3-5-sonnet-20241022'),
+  model: anthropic('claude-sonnet-4.5'),
   environment,
   environmentToolsDefinition: 'basic', // Read/write only, no deletions
   maxSteps: 15,
@@ -128,7 +132,7 @@ const agent = createCodeAgent({
   },
 });
 
-const result = await agent.execute({
+const result = await agent.generate({
   prompt: 'Create a Python script that calculates fibonacci numbers',
 });
 ```
@@ -153,7 +157,7 @@ const environments = {
 
 // Configure tools per environment
 const agent = createCodeAgent({
-  model: openai('gpt-4'),
+  model: openai('gpt-5'),
   environments,
   environmentToolsDefinition: {
     frontend: 'all',
@@ -162,7 +166,7 @@ const agent = createCodeAgent({
   maxSteps: 20,
 });
 
-const result = await agent.execute({
+const result = await agent.generate({
   prompt: 'Create a React frontend and Flask backend for a todo app',
 });
 ```
@@ -178,7 +182,7 @@ const environment = createEnvironment('node-filesystem', {
 });
 
 const agent = createCodeAgent({
-  model: google('gemini-2.0-flash-exp'),
+  model: google('gemini-2.5-pro'),
   environment,
   environmentToolsDefinition: [
     'read_file',
@@ -201,7 +205,7 @@ Enable agents to signal completion before reaching max steps:
 
 ```typescript
 const agent = createCodeAgent({
-  model: openai('gpt-4'),
+  model: openai('gpt-5'),
   environment,
   environmentToolsDefinition: 'all',
   maxSteps: 20,
@@ -215,7 +219,7 @@ Track agent execution with detailed step logs:
 
 ```typescript
 const agent = createCodeAgent({
-  model: anthropic('claude-3-5-sonnet-20241022'),
+  model: anthropic('claude-sonnet-4.5'),
   environment,
   environmentToolsDefinition: 'all',
   maxSteps: 15,
@@ -228,4 +232,4 @@ const agent = createCodeAgent({
 
 ## Contributing
 
-Contributions to the AI Code Agents SDK are welcome and highly appreciated.
+Contributions to the AI Code Agents SDK are welcome and highly appreciated. Please review the [contributing guidelines](https://github.com/felixarntz/ai-code-agents/blob/main/CONTRIBUTING.md) to learn more about how you can contribute.