create-adk-agent 0.0.1 → 0.0.2

package/README.md

@@ -1,31 +1,49 @@
-# @adk-ts-new/create-adk-agent
+# create-adk-agent
 
-> Nx generator for scaffolding ADK (Agent Development Kit) TypeScript projects with multiple templates, multi-model support, and modern tooling.
+> **The fastest way to start building with Google's Agent Development Kit (ADK)**
 
-## 🚀 Quick Start
+Scaffold production-ready ADK TypeScript projects in seconds with best practices, multiple templates, and zero configuration.
+
+**What is ADK?** The [Agent Development Kit](https://google.github.io/adk-docs/) is Google's framework for building AI agents. This tool makes it easy to get started.
 
-### Using npx (Recommended)
+## 🚀 Quick Start
 
 ```bash
-npx @adk-ts-new/create-adk-agent my-agent
+npx create-adk-agent my-agent
 ```
 
-### Using Nx workspace
+That's it! You'll get a fully configured ADK project with:
+- ✅ TypeScript configured for ADK
+- ✅ Environment setup with API key validation
+- ✅ Working agent examples from official docs
+- ✅ Hot reload development with tsx
+- ✅ Testing setup with Jest
+- ✅ All the tooling (ESLint, Prettier, etc.)
 
-```bash
-nx g @adk-ts-new/create-adk-agent:init my-agent
-```
+## 💡 Why Use This?
+
+Instead of manually setting up TypeScript, configuring ESM, managing API keys, and copying examples from docs, `create-adk-agent` does it all for you in one command.
+
+**Perfect for:**
+- 🎓 Learning ADK quickly with working examples
+- 🚀 Starting new ADK projects without boilerplate hassle
+- 📦 Getting ADK best practices out of the box
+- 🔄 Experimenting with different agent patterns
 
-## ✨ Features
+## ✨ What You Get
 
-- 🤖 **Multiple Agent Templates** - Choose from 5 different agent templates from official ADK docs
-- 🔌 **Multi-Model Support** - Works with Gemini, OpenAI, and Anthropic models
-- ⚡ **tsx Development** - Instant TypeScript execution with hot reload (no build step)
-- 🔐 **Security First** - Built-in `.env` management with clear security warnings
-- 🧪 **Testing Ready** - Pre-configured Jest testing setup
-- 📦 **Modern Stack** - TypeScript, ESLint, Prettier, Zod validation
+## ✨ What You Get
 
-## 📋 Agent Templates
+- 🤖 **5 Agent Templates** - Pre-built examples from [official ADK docs](https://google.github.io/adk-docs/) (basic, multi-tool, team, streaming, workflow)
+- 🔌 **Multi-Model Ready** - Pre-configured for Gemini, OpenAI, and Anthropic
+- ⚡ **Hot Reload** - Instant TypeScript execution with tsx (no build step needed)
+- 🔐 **Security Built-in** - Proper `.env` handling with validation and git-ignore
+- 🧪 **Testing Included** - Jest configured and ready to go
+- 📦 **Best Practices** - TypeScript, ESLint, Prettier, Zod validation
+
+## 📚 Agent Templates
+
+All templates are based on [official ADK documentation examples](https://google.github.io/adk-docs/):
 
 ### Basic Agent
 
@@ -49,28 +67,30 @@ Sequential workflow patterns with validation, transformation, and saving steps.
 
 ## 🎯 Usage
 
-### Interactive Mode
+### Simple (Interactive)
+
+Just run the command and answer a few questions:
 
 ```bash
-npx @adk-ts-new/create-adk-agent my-agent
+npx create-adk-agent my-agent
 ```
 
-You'll be prompted for:
-
-- Agent templates to include
-- Model provider (Gemini/OpenAI/Anthropic)
-- Whether to install dependencies
+You'll choose:
+- Which agent templates to include
+- Your preferred model provider (Gemini, OpenAI, or Anthropic)
+- Whether to install dependencies now
 - Whether to initialize git
 
-### Non-Interactive Mode
+### Advanced (Non-Interactive)
+
+Skip prompts by providing options:
 
 ```bash
-npx @adk-ts-new/create-adk-agent my-agent \
+npx create-adk-agent my-agent \
   --templates=basic,multi-tool \
   --modelProvider=gemini \
   --model=gemini-3.0-flash \
   --description="My custom agent" \
-  --directory=apps \
   --installDependencies \
   --no-interactive
 ```
@@ -114,7 +134,30 @@ npx @adk-ts-new/create-adk-agent my-agent \
 
 **Note:** You can change to any model after project generation. The list above is for initial setup convenience.
 
-## 📦 Generated Project Structure
+## 🎬 Getting Started Workflow
+
+```bash
+# 1. Create your project (takes ~10 seconds)
+npx create-adk-agent my-agent
+
+# 2. Navigate to project
+cd my-agent
+
+# 3. Add your API key
+cp .env.example .env
+# Edit .env and add your API key (get it from links in the file)
+
+# 4. Start coding! (hot reload enabled)
+npm run dev
+
+# 5. Or use ADK DevTools
+npm run adk:web    # Beautiful web UI
+npm run adk:run    # CLI runner
+```
+
+**That's it!** You're now building with ADK. No complex setup, no configuration headaches.
+
+## 🔗 Learn More About ADK
 
 ```
 my-agent/

package/bin/create-adk-agent.js

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+
+import { execSync } from 'child_process';
+import { fileURLToPath } from 'url';
+import { dirname, resolve } from 'path';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+// Get the arguments passed to the script (excluding node and script path)
+const args = process.argv.slice(2);
+
+// Check if a project name was provided
+if (args.length === 0) {
+  console.error('❌ Error: Please provide a project name');
+  console.error('Usage: npx create-adk-agent <project-name> [options]');
+  console.error('');
+  console.error('Example:');
+  console.error('  npx create-adk-agent my-agent');
+  console.error('  npx create-adk-agent my-agent --templates=basic,multi-tool --no-interactive');
+  process.exit(1);
+}
+
+// Build the nx command
+const generatorPath = resolve(__dirname, '..');
+const command = `npx --yes nx g ${generatorPath}:init ${args.join(' ')}`;
+
+console.log('🚀 Creating your ADK agent project...');
+console.log('');
+
+try {
+  // Execute the nx generator command
+  execSync(command, { stdio: 'inherit', cwd: process.cwd() });
+} catch (error) {
+  console.error('');
+  console.error('❌ Failed to create project');
+  process.exit(1);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-adk-agent",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Nx generator for scaffolding ADK (Agent Development Kit) TypeScript projects with multiple templates, multi-model support, and modern tooling",
   "keywords": [
     "adk",
@@ -23,6 +23,9 @@
   "author": "Maina Wycliffe",
   "license": "MIT",
   "type": "module",
+  "bin": {
+    "create-adk-agent": "./bin/create-adk-agent.js"
+  },
   "scripts": {
     "prepublishOnly": "nx build create-adk-agent",
     "publish:dry-run": "npm publish --dry-run",
@@ -43,6 +46,7 @@
   },
   "files": [
     "dist",
+    "bin",
     "generators.json",
     "src/generators/**/files/**",
     "src/generators/**/schema.json",
@@ -70,4 +74,4 @@
     "@nx/devkit": "^22.3.3",
     "@swc/helpers": "~0.5.11"
   }
-}
+}