@circuitorg/agent-cli 1.0.6 → 1.1.0

package/README.md

@@ -13,16 +13,11 @@ The official command-line tool for creating, testing, and deploying agents on th
   - [🎯 Quick Start](#-quick-start)
     - [First Steps](#first-steps)
     - [Creating Your First Agent](#creating-your-first-agent)
-      - [Step 1a - From Scratch](#step-1a---from-scratch)
-      - [Step 1b - Adding an existing agent to the CLI agent registry](#step-1b---adding-an-existing-agent-to-the-cli-agent-registry)
-      - [Steps 2-5: Soft deploy, create session for testing, test locally, deploy live](#steps-2-5-soft-deploy-create-session-for-testing-test-locally-deploy-live)
   - [📚 Command Reference](#-command-reference)
     - [Core Commands](#core-commands)
-    - [Agent Commands](#agent-commands)
-    - [Simulation Commands](#simulation-commands)
-      - [Simulation Mode Flags](#simulation-mode-flags)
-    - [Authentication Commands](#authentication-commands)
+    - [Agent Management Commands](#agent-management-commands)
     - [Wallet Commands](#wallet-commands)
+    - [Run Command Flags](#run-command-flags)
     - [Getting Started with Agents](#getting-started-with-agents)
   - [🔧 Troubleshooting](#-troubleshooting)
     - [Common Issues](#common-issues)
@@ -79,65 +74,53 @@ circuit
 ```
 
 ### Creating Your First Agent
-#### Step 1a - From Scratch
-
-```bash
-# (First time setup only) Authenticate your cli tool with your circuit account
-circuit auth login
 
+**Streamlined Workflow:**
 
-# Initialize a new agent project
-circuit agent init
+```bash
+# 1. Authenticate your cli tool with your circuit account
+circuit login
 
+# 2. Initialize a new agent project (optionally pass --no-dir to use an existing folder)
+circuit init
 # Follow the prompts to:
 # - Choose TypeScript or Python
 # - Name your agent
 # - Set up the project structure
 
-# Navigate to your new agent
-cd my-agent
+# 3. Navigate to your new agent (Skip if you passed --no-dir above)
+cd <generated-folder>
 
-# Install your local dependencies (required to run the 'circuit agent simulate' commands)
-bun install
+# 4. Install dependencies
+bun install    # For TypeScript agents
 # OR
-uv sync
+uv sync       # For Python agents
 
+# 5. Test your agent (handles setup, session creation automatically)
+circuit run
+
+# 6. Deploy to production when ready
+circuit deploy
 ```
 
-#### Step 1b - Adding an existing agent to the CLI agent registry
->Note: If you already have agents and want to deploy via the cli tool, you will need to go through the following steps to ensure the agent is aligned with the current deployment structure. 
+**Existing Agent Setup:**
 
 ```bash
-# Navigate to your existing agent
+# Navigate to your existing agent directory
 cd <existing-agent-dir>
 
-# Initialize the agent with --no-dir
-# This will add the agent to the CLI's agent registry, and add a main.py/pyproject.toml file (index.ts/package.json for TS agents) to your project.
-# If you already have a main.py file, it will create a main-RENAMEME.py file
-# If you already have a pyproject.toml file, it will simply add the correct circuit config section
-circuit agent init --no-dir
+# Initialize with --no-dir to configure existing project
+circuit init --no-dir
+# This adds the agent to CLI registry and updates config files
 
-# Install your local dependencies (required to run the 'circuit agent simulate' commands)
-bun install
+# Install dependencies
+bun install  # or uv sync for Python
 
-# Follow prompts to configure the agent
+# Test your agent
+circuit run
 ```
-- Next you will need to copy over your existing execution and stop logic, place into the execute and stop functions defined in the template main.py file. See the sdk repo for more details on the overall structure of the app, but at a high level, you will simply need to define your execute and stop functions, and pass to the Agent class, which will handle exposing the correct endpoints based on its deployment location. 
-
-#### Steps 2-5: Soft deploy, create session for testing, test locally, deploy live
-```bash
-# Soft deploy your agent to register the agent with Circuit and allow the creation of a test session
-circuit agent deploy
 
-# Create a test session
-circuit agent sessions create
-
-# Test your agent locally
-circuit agent simulate execute
-
-# When ready, deploy to Circuit
-circuit agent deploy --live
-```
+> **Note**: For existing agents, copy your execution logic into the execute/stop functions in the generated template files. See the SDK documentation for details on the Agent class structure.
 
 
 ## 📚 Command Reference
@@ -147,82 +130,57 @@ circuit agent deploy --live
 | Command | Description |
 |---------|-------------|
 | `circuit` | Start interactive mode with menu |
-| `circuit --help` | Show help information |
-| `circuit --version` | Show version information |
-| `circuit info` | Display CLI information and status |
-| `circuit configure` | Configure CLI and agent settings |
+| `circuit whoami` | Show current authenticated user |
+| `circuit login` | Authenticate with Circuit platform |
+| `circuit logout` | Sign out from Circuit platform |
+| `circuit init` | Initialize a new agent project |
+| `circuit run` | Run/test your agent (handles setup automatically) |
+| `circuit deploy` | Deploy agent to production |
+| `circuit help` | Show detailed help and getting started guide |
 
-### Agent Commands
+### Agent Management Commands
 
 | Command | Description |
 |---------|-------------|
-| `circuit agent` | Interactive agent management menu |
-| `circuit agent init` | Initialize a new agent project |
-| `circuit agent deploy` | Deploy an agent to Circuit platform |
-| `circuit agent configure` | Configure agent settings |
-| `circuit agent validate` | Validate agent configuration |
-| `circuit agent info` | Show agent information |
+| `circuit agent info` | Show current agent information |
 | `circuit agent status` | Check agent deployment status |
-| `circuit agent sessions` | Manage agent sessions |
-| `circuit agent sessions create` | Create a new agent session |
-| `circuit agent sessions kill` | Kill an agent session |
 
-### Simulation Commands
+### Wallet Commands
 
 | Command | Description |
 |---------|-------------|
-| `circuit agent simulate` | Interactive simulation menu |
-| `circuit agent simulate execute` | Execute agent logic locally |
-| `circuit agent simulate stop` | Stop agent execution locally |
+| `circuit wallet list` | List your available wallets |
+| `circuit wallet import` | Import a new wallet for testing |
 
-#### Simulation Mode Flags
+### Run Command Flags
 
-You can bypass the interactive menu by specifying the simulation mode directly:
+The `circuit run` command supports these optional flags to skip interactive prompts:
 
 | Flag | Description |
 |------|-------------|
-| `--local` or `-l` | Use local development mode (auto-start server) |
-| `--custom` or `-c` | Use custom server mode (connect to existing server) |
-| `--live` or `-L` | Use deployed/live version of the agent |
-| `--port <number>` or `-p <number>` | Specify port for custom server mode (default: prompts for input) |
+| `--wallet <address>` | Use specific wallet address |
+| `--mode local\|live\|custom` | Set simulation mode |
+| `--action execute\|stop` | Choose action to perform |
+| `--port <number>` | Port for custom server mode |
 
 **Examples:**
 ```bash
-# Test with local development server (auto-start)
-circuit agent simulate execute --local
+# Interactive mode (recommended)
+circuit run
 
-# Connect to custom server on port 8080
-circuit agent simulate execute --custom --port 8080
+# Skip prompts with flags
+circuit run --wallet 0x123... --mode local --action execute
 
-# Test the deployed/live version
-circuit agent simulate execute --live
+# Connect to custom server
+circuit run --mode custom --port 8080
 
 # Stop simulation with custom server
-circuit agent simulate stop --custom --port 8080
+circuit run --mode custom --port 8080 --action stop
 ```
 
-### Authentication Commands
-
-| Command | Description |
-|---------|-------------|
-| `circuit auth` | Interactive authentication menu |
-| `circuit auth login` | Login to Circuit platform |
-| `circuit auth logout` | Logout from Circuit platform |
-| `circuit auth whoami` | Check current user |
-
-### Wallet Commands
-
-| Command | Description |
-|---------|-------------|
-| `circuit wallet` | Interactive wallet management menu |
-| `circuit wallet import` | Import a wallet |
-| `circuit wallet list` | List all wallets |
-
-
-
 ### Getting Started with Agents
 
-When you run `circuit agent init`, the CLI will:
+When you run `circuit init`, the CLI will:
 
 1. Prompt you to choose TypeScript or Python
 2. For TypeScript: Select from available templates (bare, self-send)
@@ -261,7 +219,7 @@ Check that your agent server:
 
 #### "Authentication Required"
 
-Run `circuit auth login` to authenticate with the Circuit platform.
+Run `circuit login` to authenticate with the Circuit platform.
 
 ### Need Help?
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@circuitorg/agent-cli",
-  "version": "1.0.6",
+  "version": "1.1.0",
   "description": "A CLI tool for deploying agents to the Circuit platform",
   "type": "module",
   "bin": {
@@ -15,6 +15,7 @@
     "dev": "bun --hot src/index.ts",
     "test": "bun test",
     "test:coverage": "bun test --coverage",
+    "test:package": "bun scripts/test-package.ts",
     "typecheck": "bun tsc --noEmit",
     "format": "bun x prettier --write src/**/*.ts",
     "format:check": "bun x prettier --check src/**/*.ts",