Skip to main content
The rf agents command (or rf agent singular) provides complete agent management capabilities with an interactive menu and support for automation via non-interactive flags.

​
Commands Overview

CommandDescription
rf agents listInteractive menu to manage agents
rf agents getShow current agent details
rf agents cloneClone agent repository locally
rf agents pullPull latest changes from server
rf agents deployDeploy local changes to server
rf agents duplicateDuplicate agent on server
rf agents deleteDelete agent

​
Interactive Menu

​
List Agents

List all available agents with an interactive menu: 
rf agents list
This opens an interactive menu where you can:
  • 📋 Browse all your agents
  • 🔽 Clone repository to local machine
  • 🚀 Deploy changes to server
  • 📋 Duplicate agent on server
  • 🗑️ Delete agent
  • 👁️ View agent details
The interactive menu is the fastest way to manage agents - no need to remember multiple commands!

​
Main Commands

​
Get Agent Details

Show details of the current/selected agent: 
rf agents get
Output: 
Agent: support-bot
ID: agent_abc123
Tenant: ACME Corp (tenant_xyz)
Created: 2024-01-15
Status: Active
Repository: https://github.com/runflow-agents/support-bot

​
Clone Agent Repository

Download an agent repository to your local machine: 
rf agents clone
Or use the interactive menu (rf agents list → select agent → Clone repository). This creates a local folder with the agent’s code, allowing you to:
  • Make changes locally
  • Test changes with rf test
  • Deploy updates with rf agents deploy
What gets cloned: 
agent-name/
├── .runflow/
│   └── rf.json         # Agent configuration
├── src/
│   └── index.ts        # Agent code
├── package.json
└── README.md

​
Deploy Changes

Deploy your local changes to the server: 
cd my-agent/
rf agents deploy
Make sure you’re in the agent’s directory before deploying. The CLI detects the agent from .runflow/rf.json.
Deployment Process:
  1. Validates .runflow/rf.json exists
  2. Commits local changes to git
  3. Pushes to remote repository
  4. Server automatically rebuilds agent
  5. Agent is live with new changes

​
Pull Latest Changes

Pull the latest changes from the server (overwrites local changes): 
cd my-agent/
rf agents pull
This command will overwrite your local changes. Make sure to commit or backup your work before pulling.
When to use:
  • After changes made via dashboard
  • Sync with team member changes
  • Reset to server state

​
Duplicate Agent

Create a copy of an agent on the server: 
rf agents duplicate
Or use the interactive menu (rf agents list → select agent → Duplicate). Use cases:
  • Create dev/staging versions
  • Fork agent for different client
  • Experiment without affecting original

​
Delete Agent

Delete an agent from the server: 
# With confirmation prompt
rf agents delete

# Skip confirmation (for scripts/automation)
rf agents delete --yes
rf agents delete -y
Or use the interactive menu (rf agents list → select agent → Delete).
This action is permanent and cannot be undone! The agent and its repository will be deleted.

​
Non-Interactive Mode

All commands support --yes or -y flag to skip confirmations, perfect for automation: 
# Delete without confirmation
rf agents delete --yes

# Use in scripts
#!/bin/bash
rf agents delete --yes
echo "Agent deleted"

​
Common Workflows

​
Development Workflow

# 1. Create new agent
rf create --name my-agent --template starter --yes

# 2. Navigate to agent folder
cd my-agent/

# 3. Make your changes
# ... edit src/index.ts ...

# 4. Test locally
rf test

# 5. Deploy changes
rf agents deploy

# 6. Pull latest changes when needed (if changed via dashboard)
rf agents pull

​
Existing Agent Workflow

# 1. List and select agent (interactive menu)
rf agents list

# 2. Clone repository (select "Clone repository" from menu)
# This creates a folder with the agent name

# 3. Navigate to agent folder
cd agent-name/

# 4. Make your changes
# ... edit files ...

# 5. Test locally
rf test

# 6. Deploy changes
rf agents deploy

​
Multi-Environment Deployment

# Develop on dev environment
rf switch dev
cd my-agent/
# ... make changes ...
rf test
rf agents deploy

# Promote to staging
rf switch staging
rf agents clone  # Clone from dev
cd my-agent/
rf test
rf agents deploy

# Deploy to production
rf switch prod
rf agents clone  # Clone from staging
cd my-agent/
rf agents deploy

​
Agent Duplication & Experimentation

# Duplicate agent for testing
rf agents list
# → Select agent → Duplicate
# → Enter new name: "my-agent-experimental"

# Clone and test
rf agents clone  # Select experimental version
cd my-agent-experimental/
# ... make experimental changes ...
rf test
rf agents deploy

# If successful, apply to original
cd ../my-agent/
# ... apply changes ...
rf agents deploy

# Delete experimental version
rf agents delete --yes

​
Project Configuration

Each agent folder contains .runflow/rf.json: 
{
  "agentId": "agent_abc123",
  "agentName": "my-agent",
  "tenantId": "tenant_xyz"
}
Don’t delete or modify .runflow/rf.json - it’s required for deployment and local testing!

​
Using with AI Tools

Non-interactive mode works seamlessly with AI coding assistants: 
# Cursor / Copilot can execute these
rf agents delete --yes
rf agents deploy
rf agents pull

​
Automation Scripts

​
Bulk Deployment

#!/bin/bash

agents=("support-bot" "sales-assistant" "feedback-analyzer")

for agent in "${agents[@]}"; do
  cd "$agent"
  rf test
  if [ $? -eq 0 ]; then
    rf agents deploy
  else
    echo "Tests failed for $agent"
  fi
  cd ..
done

​
CI/CD Integration

# .github/workflows/deploy.yml
name: Deploy Agent

on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Install CLI
        run: npm i -g @runflow-ai/cli
      - name: Login
        run: rf login --api-key ${{ secrets.RUNFLOW_API_KEY }}
      - name: Deploy
        run: rf agents deploy

​
Troubleshooting

​
Not in Agent Directory

rf agents deploy
# Error: No agent configuration found (.runflow/rf.json)
Solution: Navigate to agent directory: 
cd my-agent/
rf agents deploy

​
Merge Conflicts on Pull

rf agents pull
# Error: Local changes conflict with server
Solution: 
# Commit local changes first
git add .
git commit -m "Local changes"

# Then pull
rf agents pull

# Or discard local changes
git reset --hard HEAD
rf agents pull

​
Deployment Failed

rf agents deploy
# Error: Deployment failed
Solution:
  • Check for syntax errors in your code
  • Verify all dependencies are in package.json
  • Check server logs via dashboard
  • Ensure valid .runflow/rf.json

​
Aliases

You can use either rf agents (plural) or rf agent (singular): 
rf agent list      # Same as rf agents list
rf agent deploy    # Same as rf agents deploy
rf agent clone     # Same as rf agents clone
rf agent delete -y # Same as rf agents delete -y

​
Next Steps

Create Agent

Create new agent from template

Test

Test agents locally with web interface

Knowledge Base

Add knowledge base for RAG

Prompts

Manage prompt templates