Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 91 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,9 @@ This configuration file specifies basic metadata (name, framework, version), def
}
```

## Local Deployment
## Local Development

Deploy and test your agents locally with full debugging capabilities.
Deploy and test your agents locally with full debugging capabilities before deploying to RunAgent Cloud.

### Deploy Agent Locally

Expand All @@ -115,6 +115,20 @@ This starts a local FastAPI server with:
- WebSocket support for streaming
- Built-in API documentation at `/docs`

### Deploy to RunAgent Cloud

Once your agent is tested locally, deploy to production:

```bash
# Authenticate (first time only)
runagent setup --api-key <your-api-key>

# Deploy to cloud
runagent deploy --folder .
```

Your agent will be live globally with automatic scaling, monitoring, and enterprise security. View all your agents and execution metrics in the [dashboard](https://app.run-agent.ai/dashboard).


## **LangGraph Problem Solver Agent (An Example)**

Expand Down Expand Up @@ -334,28 +348,52 @@ func main() {

---

## Action Memory System (Coming Soon)
<div align="center">

RunAgent is introducing **Action Memory** - a revolutionary approach to agent reliability that focuses on *how to remember* rather than *what to remember*.
## <b><code>🚀 RunAgent Cloud Deployment</code></b>

### How It Will Work
**Now Available: Production-Ready Cloud Infrastructure**

- **Action-Centric**: Instead of storing raw conversation data, it captures decision patterns and successful action sequences
- **Cross-Language**: Memory persists across all SDK languages seamlessly
- **Reliability Focus**: Learns from successful outcomes to improve future decisions
- **Ecosystem Integration**: Works with any framework - LangGraph, CrewAI, Letta, and more
Deploy to production in seconds with enterprise-grade infrastructure

This will ensure your agents become more reliable over time, regardless of which programming language or framework you use to interact with them.
<br>

---
<table>
<tr>
<td align="center" width="200">
<a href="https://app.run-agent.ai/auth/signin"><b>Sign Up</b></a>
</td>
<td align="center" width="200">
<a href="https://app.run-agent.ai/dashboard"><b>Dashboard</b></a>
</td>
<td align="center" width="200">
<a href="https://docs.run-agent.ai/runagent-cloud/overview"><b>Documentation</b></a>
</td>
</tr>
</table>

</div>

Deploy your agents to RunAgent Cloud with enterprise-grade infrastructure and experience the fastest agent deployment. RunAgent Cloud provides serverless auto-scaling, comprehensive security, and real-time monitoring - all managed for you.

### Get Started with RunAgent Cloud

## Remote Deployment (Coming very soon)
1. **Sign up** at [app.run-agent.ai](https://app.run-agent.ai/auth/signin)
2. **Generate API Key**: After signing in, go to **Settings → API Keys → Generate API Key**
3. **Authenticate CLI**: Configure your CLI with your API key
4. **Deploy**: Deploy your agents with a single command

Deploy your agents with enterprise-grade infrastructure and experience the fastest agent deployment.
```bash
# Authenticate with RunAgent Cloud
runagent setup --api-key <your-api-key>

# Deploy your agent
runagent deploy --folder ./my-agent
```

### Fastest agent deployment
### Fastest Agent Deployment

From zero to production in the time it takes to draw a breath, making **RunAgent** one of the fastest agent deployment platforms available on planet earth 🌍 .
From zero to production in seconds. RunAgent Cloud automatically selects the optimal VM image based on your agent's requirements, with deployment typically completing in 30-60 seconds for standard images, or up to 2 minutes for specialized configurations.

### Security-First Architecture

Expand All @@ -365,24 +403,55 @@ Every agent runs in its own **isolated sandbox environment**:
- Resource limits and monitoring
- Zero data leakage between agents

### ✨ The +++999 Aura of Agent Deployment
### Dashboard & Monitoring

Our remote deployment will provide:
The RunAgent Cloud dashboard provides comprehensive insights into your agents:

- Auto-scaling based on demand
- Global edge distribution
- Built-in monitoring and analytics
- Production-grade security and compliance
- **Agent Execution Metadata** - Detailed information about each execution
- **Execution Time Tracking** - Monitor performance and optimize accordingly
- **Agent Management** - View and manage all your deployed agents
- **Usage Analytics** - Track usage patterns and resource consumption
- **Real-time Monitoring** - Live status and health checks
- **Execution History** - Complete audit trail of all agent invocations

Access your dashboard at [app.run-agent.ai/dashboard](https://app.run-agent.ai/dashboard) after signing in.

### Enterprise-Grade Features

## Documentation
RunAgent Cloud provides:

- **Auto-scaling** - Automatically scales based on demand
- **Global Edge Distribution** - Low-latency access worldwide
- **Built-in Monitoring** - Comprehensive analytics and observability
- **Production-Grade Security** - Enterprise security and compliance
- **Multiple VM Images** - Automatic image selection optimized for your agent
- **Serverless Infrastructure** - Zero infrastructure management

---

## 📚 Documentation

- **[Getting Started](https://docs.run-agent.ai/get-started/introduction.md)** - Deploy your first agent in 5 minutes
- **[CLI Reference](https://docs.run-agent.ai/cli/overview.md)** - Complete command-line interface guide
- **[SDK Documentation](https://docs.run-agent.ai/sdk/overview.md)** - Multi-language SDK guides
- **[Framework Guides](https://docs.run-agent.ai/frameworks/overview.md)** - Framework-specific tutorials
- **[API Reference](https://docs.run-agent.ai/api-reference/introduction.md)** - REST API documentation
- **[RunAgent Cloud Guide](https://docs.run-agent.ai/runagent-cloud/overview)** - Complete cloud deployment guide

---

## 🧠 Action Memory System (Coming Soon)

RunAgent is introducing **Action Memory** - a revolutionary approach to agent reliability that focuses on *how to remember* rather than *what to remember*.

### How It Will Work

- **Action-Centric**: Instead of storing raw conversation data, it captures decision patterns and successful action sequences
- **Cross-Language**: Memory persists across all SDK languages seamlessly
- **Reliability Focus**: Learns from successful outcomes to improve future decisions
- **Ecosystem Integration**: Works with any framework - LangGraph, CrewAI, Letta, and more

This will ensure your agents become more reliable over time, regardless of which programming language or framework you use to interact with them.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/endpoints/health.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,6 @@ def update_metrics(agent_id):

## See Also

- [Monitoring Guide](/deployment/cloud-deployment#monitoring) - Full monitoring setup
- [Monitoring Guide](/runagent-cloud/cloud-deployment#monitoring) - Full monitoring setup
- [Status Endpoint](/api-reference/endpoints/get-agent) - Detailed agent info
- [Metrics API](/api-reference/webhooks) - Metrics collection
2 changes: 1 addition & 1 deletion docs/configuration/environment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -294,5 +294,5 @@ for key, value in os.environ.items():
## See Also

- [Configuration File](/configuration/config-file) - Config structure
- [Security Best Practices](/deployment/cloud-deployment) - Production security
- [Security Best Practices](/runagent-cloud/cloud-deployment) - Production security
- [Local Development](/deployment/local-development) - Development setup
121 changes: 107 additions & 14 deletions docs/deployment/cloud-deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -131,17 +131,94 @@ Starting agent: abc-123-def-456
🌐 Endpoint: https://api.run-agent.ai/api/v1/agents/abc-123-def-456/execute
```

## Agent Configuration

### Agent ID and Entrypoints

When you initialize a new agent with `runagent init`, it automatically:
1. **Generates a unique agent ID** and adds it to `runagent.config.json`
2. **Creates a basic configuration** with framework and template settings

**Important:** You must add your entrypoints to the configuration file before deploying.

#### Using `runagent init` (Recommended)

```bash
# Initialize a new agent
runagent init my-agent --framework langgraph

# This creates runagent.config.json with:
# - Generated agent_id
# - Framework configuration
# - Empty entrypoints array (you need to add these)
```

**Example `runagent.config.json` after init:**
```json
{
"agent_name": "my-agent",
"agent_id": "abc-123-def-456",
"version": "1.0.0",
"framework": "langgraph",
"agent_architecture": {
"entrypoints": [] // ← You need to add entrypoints here
}
}
```

**Add your entrypoints:**
```json
{
"agent_name": "my-agent",
"agent_id": "abc-123-def-456",
"version": "1.0.0",
"framework": "langgraph",
"agent_architecture": {
"entrypoints": [
{
"tag": "chat",
"file": "main.py",
"module": "chat_agent"
},
{
"tag": "chat_stream",
"file": "main.py",
"module": "chat_agent_stream"
}
]
}
}
```

#### Manually Editing Agent ID

If you manually edit the `agent_id` in `runagent.config.json`, you **must register** the agent:

```bash
# Register the agent after manually editing agent_id
runagent register .

# Or use the config command
runagent config --register-agent .
```

<Warning>
**Important:** If you manually change the `agent_id` in your config file, RunAgent won't recognize it until you register it. Always run `runagent register .` after manually editing the agent ID.
</Warning>

## Agent Validation

Before upload, RunAgent validates your agent:

### Required Files
- `runagent.config.json` - Agent configuration
- `runagent.config.json` - Agent configuration with valid `agent_id` and `entrypoints`
- `main.py` or `agent.py` - Entry point file
- `requirements.txt` - Python dependencies (optional)

### Validation Checks
- ✅ Configuration file exists and is valid JSON
- ✅ Agent ID exists in configuration
- ✅ Agent ID is registered (if manually edited)
- ✅ Entry point file exists
- ✅ Entrypoints are properly defined
- ✅ Framework is supported
Expand All @@ -151,15 +228,18 @@ Before upload, RunAgent validates your agent:
```json
{
"agent_name": "my-agent",
"agent_id": "abc-123-def-456",
"version": "1.0.0",
"framework": "langgraph",
"entrypoints": [
{
"tag": "chat",
"file": "main.py",
"module": "agent.chat"
}
]
"agent_architecture": {
"entrypoints": [
{
"tag": "chat",
"file": "main.py",
"module": "agent.chat"
}
]
}
}
```

Expand Down Expand Up @@ -236,10 +316,17 @@ runagent run --id <agent-id> --tag <entrypoint> --input config.json
For streaming entrypoints (must end with `_stream`):

```bash
# Run streaming endpoint
runagent run --id <agent-id> --tag chat_stream --message="Tell me a story"
# Run streaming endpoint using run-stream command
runagent run-stream --id <agent-id> --tag chat_stream --message="Tell me a story"

# Or with local agent
runagent run-stream --id <agent-id> --tag chat_stream --local --message="Tell me a story"
```

<Note>
**Important:** Use `runagent run-stream` (not `runagent run`) for streaming execution. The `run-stream` command uses WebSocket connections for real-time streaming.
</Note>

## Cloud vs Local Deployment

| Feature | Local | Cloud |
Expand All @@ -262,16 +349,22 @@ runagent run --id <agent-id> --tag chat_stream --message="Tell me a story"
runagent init my-agent --framework langgraph --template default
cd my-agent

# 2. Test locally
# 2. Add entrypoints to runagent.config.json
# Edit the file and add your entrypoints to agent_architecture.entrypoints

# 3. If you manually edited agent_id, register it
runagent register .

# 4. Test locally
runagent serve

# 3. Authenticate (if not already done)
# 5. Authenticate (if not already done)
runagent setup --api-key <your-key>

# 4. Deploy to cloud
# 6. Deploy to cloud
runagent deploy --folder .

# 5. Test cloud deployment
# 7. Test cloud deployment
runagent run --id <agent-id> --tag chat --message="Hello"
```

Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/local-development.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,6 @@ runagent serve .

## See Also

- [Cloud Deployment](/deployment/cloud-deployment) - Deploy to production
- [Cloud Deployment](/runagent-cloud/cloud-deployment) - Deploy to production
- [CLI Reference](/cli/overview) - Complete CLI documentation
- [Troubleshooting](/resources/troubleshooting) - Common issues
15 changes: 13 additions & 2 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,7 @@
{
"group": "Deployment",
"pages": [
"deployment/local-development",
"deployment/cloud-deployment"
"deployment/local-development"
]
},
{
Expand All @@ -105,6 +104,18 @@
}
]
},
{
"tab": "RunAgent Cloud",
"groups": [
{
"group": "RunAgent Cloud",
"pages": [
"runagent-cloud/overview",
"runagent-cloud/cloud-deployment"
]
}
]
},
{
"tab": "Reference",
"groups": [
Expand Down
2 changes: 1 addition & 1 deletion docs/explanation/architecture-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -482,7 +482,7 @@ graph TB
<Card title="Performance Tuning" icon="speed" href="/how-to/advanced-tasks">
Learn advanced performance optimization techniques
</Card>
<Card title="Deployment" icon="cloud" href="/how-to/deployment/cloud-deployment">
<Card title="Deployment" icon="cloud" href="/runagent-cloud/cloud-deployment">
Deploy your agents to production
</Card>
</CardGroup>
Expand Down
Loading