DocsUseful Pluginsshell_approval

shell_approval

Require user approval before executing shell commands

Download

What it does

Before executing shell commands, this plugin:

Auto-approves safe commands

Read-only commands like ls, cat, git status execute without prompts.

Asks approval for other commands

Commands that modify files, install packages, or have side effects require user confirmation.

Quick Start

main.py

from connectonion import Agent
from connectonion.useful_plugins import shell_approval

def run_command(command: str) -> str:
    """Execute a shell command."""
    import subprocess
    return subprocess.check_output(command, shell=True).decode()

agent = Agent("devops", tools=[run_command], plugins=[shell_approval])

agent.input("List files then delete test.txt")

Python REPL

Interactive

[Tool: run_command("ls")] # Auto-approved (safe)

file1.txt test.txt readme.md

┌─ Shell Command ────────────────────┐

│ rm test.txt │

└────────────────────────────────────┘

Execute this command?

> Yes, execute

> Auto approve 'rm' in this session

> No, tell agent what I want

Safe Commands (Auto-Approved)

These read-only commands are automatically approved:

File Operations

ls, ll
cat, head, tail
less, more
find, fd
grep, rg
tree, wc

Git (Read-Only)

git status
git log
git diff
git show
git branch
git remote

System Info

pwd, whoami
env, printenv
uname, hostname
df, du, free
ps, top
which, file

Approval Options

When prompted for approval, you can:

Yes, execute

Execute this specific command

Auto approve '{cmd}'

Auto-approve all commands starting with this (e.g., all rm commands for this session)

No, tell agent what I want

Reject and provide feedback to the agent

How it works

main.py

@before_each_tool
def _check_approval(agent):
    pending = agent.current_session.get('pending_tool')
    if not pending:
        return

    # Only check bash/shell tools
    if pending['name'] not in ('bash', 'shell', 'run'):
        return

    command = pending['arguments'].get('command', '')

    # Skip if safe read-only command
    if _is_safe(command):
        return

    # Skip if this command type was auto-approved
    approved_cmds = agent.current_session.get('shell_approved_cmds', set())
    if command.split()[0] in approved_cmds:
        return

    # Show command and ask for approval
    choice = pick("Execute this command?", [
        "Yes, execute",
        f"Auto approve '{command.split()[0]}' in this session",
        "No, tell agent what I want"
    ])

    if choice == "No, tell agent what I want":
        feedback = input("What do you want instead? ")
        raise ValueError(f"User feedback: {feedback}")

Events Used

Event	Handler	Purpose
`before_each_tool`	_check_approval	Check and prompt before shell commands

Source

connectonion/useful_plugins/shell_approval.py

main.py

# The plugin is just a list with one event handler
shell_approval = [before_each_tool(_check_approval)]

image_result_formatter

Agent Serving