@circuitorg/agent-cli 1.0.5 → 1.0.6

package/README.md

@@ -9,10 +9,7 @@ The official command-line tool for creating, testing, and deploying agents on th
   - [🚀 Features](#-features)
   - [📦 Installation](#-installation)
     - [Installation Methods Explained](#installation-methods-explained)
-    - [For Private Repository Access](#for-private-repository-access)
-      - [Option 1: Direct Download (All Platforms)](#option-1-direct-download-all-platforms)
-      - [Option 2: Install via npm/Bun (Requires node/Bun Runtime)](#option-2-install-via-npmbun-requires-nodebun-runtime)
-    - [Installation Size Comparison](#installation-size-comparison)
+      - [Option 1: Install via Bun (Requires Bun runtime)](#option-1-install-via-bun-requires-bun-runtime)
   - [🎯 Quick Start](#-quick-start)
     - [First Steps](#first-steps)
     - [Creating Your First Agent](#creating-your-first-agent)
@@ -26,12 +23,6 @@ The official command-line tool for creating, testing, and deploying agents on th
       - [Simulation Mode Flags](#simulation-mode-flags)
     - [Authentication Commands](#authentication-commands)
     - [Wallet Commands](#wallet-commands)
-  - [🔧 Configuration](#-configuration)
-    - [Project Configuration](#project-configuration)
-  - [🏗️ Agent Development](#️-agent-development)
-    - [Supported Project Types](#supported-project-types)
-      - [TypeScript Agents](#typescript-agents)
-      - [Python Agents](#python-agents)
     - [Getting Started with Agents](#getting-started-with-agents)
   - [🔧 Troubleshooting](#-troubleshooting)
     - [Common Issues](#common-issues)
@@ -39,8 +30,6 @@ The official command-line tool for creating, testing, and deploying agents on th
       - ["Server failed to start within timeout"](#server-failed-to-start-within-timeout)
       - ["Authentication Required"](#authentication-required)
     - [Need Help?](#need-help)
-  - [📄 License](#-license)
-  - [📞 Support](#-support)
   - [🔗 Related](#-related)
 
 ## 🚀 Features
@@ -56,142 +45,24 @@ The official command-line tool for creating, testing, and deploying agents on th
 
 ### Installation Methods Explained
 
-**Two ways to install Circuit CLI:**
+**How to install Circuit CLI:**
 
-1. **Standalone Executable (Recommended)** - No dependencies required
-   - What you get: A self-contained binary with embedded Bun runtime
-   - File size: ~57MB (includes everything needed)
-   - Best for: Python developers, CI/CD, users without Bun installed
-   - Works anywhere, no runtime dependencies
+1. **Bun package manager** - Requires Bun runtime
+2. **NPM package manager** - Coming soon
 
-2. **npm/Bun Package** - Requires Bun runtime
-   - What you get: Minified JavaScript bundle that runs with your local Bun
-   - File size: ~640KB (minified bundle)
-   - Best for: JavaScript/TypeScript developers who already have Bun
-   - Requires: Bun v1.0.0 or higher installed on your system
 
-### For Private Repository Access
-
-Since this repository is currently private, you'll need to download the executables directly from the GitHub releases page.
-
-#### Option 1: Direct Download (All Platforms)
-
-1. Go to the [releases page](https://github.com/circuitorg/agents-cli/releases/latest)
-2. Download the appropriate file for your platform:
-   - **macOS Intel**: `circuit-darwin-x64-vX.X.X.tar.gz`
-   - **macOS Apple Silicon**: `circuit-darwin-arm64-vX.X.X.tar.gz`
-   - **Linux x64**: `circuit-linux-x64-vX.X.X.tar.gz`
-   - **Linux ARM64**: `circuit-linux-arm64-vX.X.X.tar.gz`
-   - **Windows**: `circuit-windows-x64-vX.X.X.zip`
-
-3. Extract and install:
-```bash
-# macOS/Linux - One Liner after download
-cd ~/Downloads && tar -xzf circuit-darwin-arm64-v0.1.29.tar.gz && \
-sudo mv circuit-darwin-arm64 /usr/local/bin/circuit && \
-sudo xattr -rd com.apple.quarantine /usr/local/bin/circuit
-
-# Verify installation
-circuit --version
-```
-
-#### Option 2: Install via npm/Bun (Requires node/Bun Runtime)
+#### Option 1: Install via Bun (Requires Bun runtime)
 
 **⚠️ Prerequisites**: 
 - You must have Bun or node installed - bun install link: (`curl -fsSL https://bun.sh/install | bash`)
-- For global install, you must have a properly configured ~/.npmrc file
-```bash
-# Sample .npmrc file
-# Create a GitHub Personal Access Token with `read:packages` scope
-# https://github.com/settings/tokens/new
-@circuitorg:registry=https://npm.pkg.github.com
-//npm.pkg.github.com/:_authToken=${NPM_TOKEN}
-```
 
 ```bash
-# Install the CLI (this installs TypeScript source, not a binary)
-npm install -g @circuitorg/agent-cli
-# or with Bun
 bun install -g @circuitorg/agent-cli
 ```
 
 **Note**: This method installs a minified JavaScript bundle, not a compiled binary. The `circuit` command will run using your local Bun runtime.
 
 
-<!-- Remove this comment block when the repository becomes public -->
-<!--
-### For Public Repository (Future)
-### Option 1: Quick Install (Recommended)
-
-Download and install the standalone executable - no dependencies required:
-
-#### macOS/Linux (One-liner)
-```bash
-# Automatic detection of platform and architecture
-curl -fsSL https://raw.githubusercontent.com/circuitorg/agents-cli/main/install.sh | bash
-```
-
-#### macOS/Linux (Manual one-liner for specific platforms)
-```bash
-# macOS Apple Silicon
-curl -L https://github.com/circuitorg/agents-cli/releases/latest/download/circuit-darwin-arm64.tar.gz | tar -xz && sudo install -m 755 circuit-darwin-arm64 /usr/local/bin/circuit
-
-# macOS Intel
-curl -L https://github.com/circuitorg/agents-cli/releases/latest/download/circuit-darwin-x64.tar.gz | tar -xz && sudo install -m 755 circuit-darwin-x64 /usr/local/bin/circuit
-
-# Linux x64
-curl -L https://github.com/circuitorg/agents-cli/releases/latest/download/circuit-linux-x64.tar.gz | tar -xz && sudo install -m 755 circuit-linux-x64 /usr/local/bin/circuit
-```
-
-#### Windows
-```powershell
-# Quick install (PowerShell)
-Invoke-WebRequest -Uri "https://github.com/circuitorg/agents-cli/releases/latest/download/circuit-windows-x64.exe.zip" -OutFile "circuit.zip"
-Expand-Archive "circuit.zip" -Force
-Remove-Item "circuit.zip"
-# Add to PATH or move circuit.exe to a PATH directory
-```
-
-### Option 2: Install with package managers
-
-```bash
-# With Homebrew (macOS/Linux)
-brew install circuitorg/tap/circuit
-
-# With npm
-npm install -g @circuitorg/agent-cli
-
-# With Bun
-bun install -g @circuitorg/agent-cli
-```
-
-| Platform | Architecture | Download |
-|----------|--------------|----------|
-| macOS | Apple Silicon (M1/M2) | `circuit-darwin-arm64.tar.gz` |
-| macOS | Intel | `circuit-darwin-x64.tar.gz` |
-| Linux | x64 | `circuit-linux-x64.tar.gz` |
-| Linux | ARM64 | `circuit-linux-arm64.tar.gz` |
-| Windows | x64 | `circuit-windows-x64.exe.zip` |
-
-After downloading:
-```bash
-# macOS/Linux
-tar -xzf circuit-<platform>.tar.gz
-sudo mv circuit-<platform> /usr/local/bin/circuit
-chmod +x /usr/local/bin/circuit
-
-# Windows
-# Extract the zip and add to PATH
-```
--->
-
-### Installation Size Comparison
-
-| Method | Download Size | Installed Size | Runtime Required |
-|--------|---------------|----------------|------------------|
-| Standalone Executable | ~20-25MB (compressed) | ~57MB | None (self-contained) |
-| npm/Bun Package | ~640KB | ~640KB | Bun v1.0.0+ |
-
 ## 🎯 Quick Start
 
 ### First Steps
@@ -200,14 +71,11 @@ chmod +x /usr/local/bin/circuit
 # Verify installation
 circuit --version
 
-# See all available commands
-circuit --help
+# RECOMMENDED FIRST STEP: Get an overview of the tooling and quick start guide
+circuit help
 
 # Start with interactive mode (recommended for beginners)
 circuit
-
-# Get a welcome overview and quick start guide
-circuit welcome
 ```
 
 ### Creating Your First Agent
@@ -231,6 +99,8 @@ cd my-agent
 
 # Install your local dependencies (required to run the 'circuit agent simulate' commands)
 bun install
+# OR
+uv sync
 
 ```
 
@@ -350,74 +220,12 @@ circuit agent simulate stop --custom --port 8080
 
 
 
-## 🔧 Configuration
-
-### Project Configuration
-
-Create a `circuit.json` file in your agent project:
-
-```json
-{
-  "name": "my-agent",
-  "description": "My Circuit agent",
-  "environment": "development",
-  "projectType": "custom",
-  "runCommand": "bun index.ts",
-  "circuit": {
-    "name": "My Agent",
-    "slug": "my-agent",
-    "description": "A test agent",
-    "version": 1,
-    "defaultSleepIntervalMinutes": 15,
-    "imageUrl": "https://i.imgur.com/GCjt5Hs.png",
-    "allowedWalletTypes": ["ethereum"],
-    "filesToExclude": ["node_modules", ".git", "*.log"]
-  }
-}
-```
-
-## 🏗️ Agent Development
-
-### Supported Project Types
-
-The CLI supports two project types:
-
-#### TypeScript Agents
-
-```bash
-# Initialize TypeScript agent
-circuit agent init
-
-# Project structure:
-my-agent/
-├── index.ts          # Main agent file
-├── package.json      # Dependencies with @circuitorg/agents-sdk@0.1.4
-└── circuit.json      # Agent configuration
-```
-
-**Available Templates:**
-- **Bare**: Simple message sending template (recommended for beginners)
-- **More to come!**
-  
-#### Python Agents
-
-```bash
-# Initialize Python agent
-circuit agent init
-
-# Project structure:
-my-agent/
-├── main.py           # Main agent file
-├── pyproject.toml    # Dependencies
-└── circuit.json      # Agent configuration
-```
-
 ### Getting Started with Agents
 
 When you run `circuit agent init`, the CLI will:
 
 1. Prompt you to choose TypeScript or Python
-2. For TypeScript: Select from available templates (bare, self-send, kitchen-sink-evm, or kitchen-sink-solana)
+2. For TypeScript: Select from available templates (bare, self-send)
 3. Create a complete project structure with:
    - Main agent file with example code
    - Configuration file (`circuit.json`)
@@ -468,19 +276,8 @@ circuit agent --help
 circuit --verbose
 ```
 
-## 📄 License
-
-MIT License - see [LICENSE](LICENSE) for details.
-
-
-## 📞 Support
-
-- **Documentation**: [GitHub Wiki](https://github.com/circuitorg/agents-cli/wiki)
-- **Issues**: [GitHub Issues](https://github.com/circuitorg/agents-cli/issues)
-- **Discussions**: [GitHub Discussions](https://github.com/circuitorg/agents-cli/discussions)
-
 ## 🔗 Related
 
-- [Circuit Platform](https://circuit.org)
-- [Circuit Agents SDK](https://github.com/circuitorg/agents-sdk)
+- [Circuit Agents SDK Typescript](https://www.npmjs.com/package/@circuitorg/agent-sdk)
+- [Circuit Agents SDK Python](https://pypi.org/project/circuit-agent-sdk/)
 - [Bun Runtime](https://bun.sh)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@circuitorg/agent-cli",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "A CLI tool for deploying agents to the Circuit platform",
   "type": "module",
   "bin": {