create-adk-agent 0.0.2 → 0.0.5

package/templates/basic/README.md

@@ -0,0 +1,155 @@
+# __PROJECT_NAME__
+
+__DESCRIPTION__
+
+## Features
+
+- ✅ TypeScript support with ES2022 target
+- ✅ Hot reload development with tsx
+- ✅ Multiple LLM provider support (Gemini, OpenAI, Anthropic)
+- ✅ Environment-based configuration
+- ✅ Jest testing setup
+- ✅ ESLint and Prettier configured
+
+## Prerequisites
+
+- Node.js 20+ (for ADK compatibility)
+- An API key from your chosen LLM provider
+
+## Getting Started
+
+### 1. Install Dependencies
+
+```bash
+npm install
+```
+
+### 2. Configure Environment
+
+Copy `.env.example` to `.env` and add your API key:
+
+```bash
+cp .env.example .env
+```
+
+Edit `.env` and add your API key:
+
+```env
+# For Google Gemini (default)
+GEMINI_API_KEY=your_api_key_here
+
+# OR for OpenAI
+OPENAI_API_KEY=your_openai_key_here
+
+# OR for Anthropic
+ANTHROPIC_API_KEY=your_anthropic_key_here
+```
+
+### 3. Run in Development Mode
+
+```bash
+npm run dev
+```
+
+This starts the agent with hot reload - any code changes will automatically restart the agent.
+
+### 4. Run in Production Mode
+
+```bash
+npm run build
+npm run prod
+```
+
+## Project Structure
+
+```
+src/
+├── index.ts          # Main entry point with agent configuration
+└── tools/            # Custom tools for the agent
+tests/
+└── agents.test.ts    # Agent tests
+```
+
+## Available Scripts
+
+- `npm run dev` - Start with hot reload (development)
+- `npm start` - Run once (no reload)
+- `npm run build` - Build TypeScript to JavaScript
+- `npm run prod` - Run built JavaScript
+- `npm test` - Run tests
+- `npm run lint` - Lint code
+- `npm run format` - Format code with Prettier
+
+## Using Different LLM Providers
+
+### Google Gemini (Default)
+
+```typescript
+import { LlmAgent } from '@google/adk';
+
+const agent = new LlmAgent({
+  model: 'gemini-2.0-flash',
+  // ...
+});
+```
+
+### OpenAI via LiteLLM
+
+```typescript
+import { LlmAgent, LiteLlm } from '@google/adk';
+
+const agent = new LlmAgent({
+  model: new LiteLlm({ model: 'openai/gpt-4o' }),
+  // ...
+});
+```
+
+### Anthropic via LiteLLM
+
+```typescript
+import { LlmAgent, LiteLlm } from '@google/adk';
+
+const agent = new LlmAgent({
+  model: new LiteLlm({ model: 'anthropic/claude-3-5-sonnet' }),
+  // ...
+});
+```
+
+## Security Notes
+
+⚠️ **Never commit your `.env` file or API keys to version control!**
+
+The `.gitignore` is configured to exclude:
+- `.env` and `.env.local`
+- API keys and sensitive data
+
+## Troubleshooting
+
+### Missing API Key Error
+
+If you see an error about missing API keys:
+
+1. Ensure `.env` file exists in project root
+2. Verify the correct API key variable is set
+3. Check that the API key is valid
+
+### TypeScript Import Errors
+
+ADK requires `verbatimModuleSyntax: false` in `tsconfig.json`. This is already configured.
+
+### Module Resolution Issues
+
+Make sure to use `.js` extensions in imports:
+
+```typescript
+import { myFunction } from './myModule.js';
+```
+
+## Learn More
+
+- [ADK Documentation](https://google.github.io/adk-docs/)
+- [ADK GitHub](https://github.com/google/adk)
+
+## License
+
+MIT

package/templates/basic/_gitignore

@@ -0,0 +1,8 @@
+node_modules
+dist
+.env
+.env.local
+*.log
+.DS_Store
+coverage
+.adk

package/templates/basic/jest.config.ts

@@ -0,0 +1,8 @@
+export default {
+  preset: 'ts-jest/presets/default-esm',
+  testEnvironment: 'node',
+  extensionsToTreatAsEsm: ['.ts'],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+};

package/templates/basic/package.json

@@ -0,0 +1,41 @@
+{
+    "name": "__PROJECT_NAME__",
+    "version": "1.0.0",
+    "description": "__DESCRIPTION__",
+    "type": "module",
+    "main": "dist/index.js",
+    "scripts": {
+        "dev": "tsx watch src/index.ts",
+        "start": "tsx src/index.ts",
+        "build": "tsc",
+        "prod": "node dist/index.js",
+        "test": "jest",
+        "test:watch": "jest --watch",
+        "lint": "eslint src/**/*.ts",
+        "format": "prettier --write src/**/*.ts"
+    },
+    "keywords": [
+        "adk",
+        "agent",
+        "ai",
+        "llm"
+    ],
+    "license": "MIT",
+    "dependencies": {
+        "@google/adk": "^0.2.0",
+        "@google/adk-devtools": "^0.2.0",
+        "dotenv": "^16.4.0",
+        "zod": "^3.23.0"
+    },
+    "devDependencies": {
+        "@types/node": "^20.10.0",
+        "@typescript-eslint/eslint-plugin": "^7.0.0",
+        "@typescript-eslint/parser": "^7.0.0",
+        "eslint": "^8.56.0",
+        "jest": "^29.7.0",
+        "prettier": "^3.2.0",
+        "ts-jest": "^29.1.0",
+        "tsx": "^4.7.0",
+        "typescript": "^5.9.3"
+    }
+}

package/templates/basic/src/index.ts

@@ -0,0 +1,60 @@
+import 'dotenv/config';
+import { LlmAgent, FunctionTool } from '@google/adk';
+import { z } from 'zod';
+
+// Validate environment variables
+if (!process.env.GEMINI_API_KEY && !process.env.OPENAI_API_KEY && !process.env.ANTHROPIC_API_KEY) {
+  console.error('❌ Error: No API key found!');
+  console.error('Please set one of the following in your .env file:');
+  console.error('  - GEMINI_API_KEY (for Google Gemini)');
+  console.error('  - OPENAI_API_KEY (for OpenAI)');
+  console.error('  - ANTHROPIC_API_KEY (for Anthropic/Claude)');
+  process.exit(1);
+}
+
+// Tool to get current time
+const getCurrentTime = new FunctionTool({
+  name: 'get_current_time',
+  description: 'Returns the current time in the specified timezone.',
+  parameters: z.object({
+    timezone: z
+      .string()
+      .optional()
+      .describe('The timezone to use (e.g., "America/New_York", "Europe/London")'),
+  }),
+  execute: ({ timezone = 'UTC' }) => {
+    const now = new Date();
+    const timeString = now.toLocaleString('en-US', { timeZone: timezone });
+    return {
+      status: 'success',
+      report: `The current time in ${timezone} is ${timeString}`,
+    };
+  },
+});
+
+// Create the agent
+export const rootAgent = new LlmAgent({
+  name: 'hello_time_agent',
+  model: __MODEL_CONFIG__,
+  description: 'An agent that can tell you the current time in any timezone.',
+  instruction: `You are a friendly time-telling assistant. When asked about the time, 
+use the get_current_time tool to provide the current time in the requested timezone. 
+If no timezone is specified, use UTC as the default.`,
+  tools: [getCurrentTime],
+});
+
+// Run the agent (for direct execution)
+if (import.meta.url === `file://${process.argv[1]}`) {
+  console.log('🤖 Hello Time Agent is ready!');
+  console.log('Ask me about the time in any timezone.\n');
+  
+  rootAgent
+    .query('What time is it in Tokyo?')
+    .then((response) => {
+      console.log('Agent response:', response);
+    })
+    .catch((error) => {
+      console.error('Error:', error);
+      process.exit(1);
+    });
+}

package/templates/basic/tests/agents.test.ts

@@ -0,0 +1,19 @@
+import { describe, it, expect } from '@jest/globals';
+import { rootAgent } from '../src/index.js';
+
+describe('Time Agent', () => {
+  it('should have correct name', () => {
+    expect(rootAgent.name).toBe('hello_time_agent');
+  });
+
+  it('should have get_current_time tool', () => {
+    expect(rootAgent.tools).toHaveLength(1);
+    expect(rootAgent.tools[0].name).toBe('get_current_time');
+  });
+
+  it('should return time when queried', async () => {
+    const response = await rootAgent.query('What time is it?');
+    expect(response).toBeDefined();
+    expect(typeof response).toBe('string');
+  }, 30000);
+});

package/templates/basic/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "lib": ["ES2022"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "verbatimModuleSyntax": false
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "tests"]
+}