README.md

Open Agent SDK Quickstart Example

This is a quickstart example for open-agent-sdk using the workspace reference.

📦 Installation

This example uses the workspace reference, so dependencies are automatically linked:

bun install

🔑 Configuration

Copy .env.example to .env and add your API Key:

cp .env.example .env
# Edit .env file and add your GEMINI_API_KEY

Or set environment variables directly:

export GEMINI_API_KEY=your_gemini_api_key_here

These quickstart scripts are currently Gemini-first. For Codex OAuth usage, run codex login and use the main SDK or oas --provider codex.

🚀 Run Tests

1. Basic Test

Test basic prompt functionality, file operations, and code analysis:

bun test-basic.ts

2. Session Test

Test multi-turn conversations with context preservation:

bun test-session.ts

3. Tools Test

Test built-in tools (Glob, Bash, WebSearch):

bun test-tools.ts

Run All Tests

bun run test

📝 Test Files

File	Description
test-basic.ts	Basic functionality: Q&A, file operations, code analysis
test-session.ts	Session-based multi-turn conversation test
test-tools.ts	Tool usage test: Glob, Bash, WebSearch

⚠️ Notes

1. Model: These quickstart scripts currently use Gemini models by default.

2. Codex OAuth: For Codex-backed usage, run codex login and use provider: 'codex' with a model such as gpt-5.4.

3. Runtime: This example uses Bun to run TypeScript files directly.

📚 More Documentation

• Open Agent SDK GitHub
• API Reference