Skip to main content

Guards plugin for Axio TUI

Project description

axio-tui-guards

PyPI Python License: MIT

Permission guard plugins for axio-tui.

Guards intercept tool calls before execution and can allow, modify, or deny them. Ships two guards: a path-access guard that asks the user before touching filesystem locations, and an LLM-based guard that reviews tool calls for safety.

Features

  • PathGuard — intercepts tools that touch the filesystem; prompts the user once per directory and remembers the decision for the session
  • LLMGuard — runs a secondary LLM call to review each tool invocation before allowing it
  • PermissionGuard protocol — both guards implement axio.PermissionGuard and compose cleanly
  • TUI-aware — prompts appear as native axio-tui dialogs, not blocking stdin reads

Installation

pip install axio-tui-guards

Or install as part of the TUI bundle:

pip install "axio-tui[guards]"

Guards

PathGuard

Intercepts tool calls that contain filesystem paths (file_path, filename, directory, path, cwd). On the first access to a new directory it asks the user to allow, allow all (subtree), or deny.

from axio_tui_guards.guards import PathGuard
from axio.tool import Tool

guard = PathGuard()   # uses TUI prompt_fn by default

tool = Tool(
    name="write_file",
    description="Write a file",
    handler=WriteFile,
    guards=(guard,),
)

Decision caching:

  • Allow — grants access to the parent directory for the current session
  • Allow all — grants access to the directory and all subdirectories
  • Deny — blocks this path; raises GuardError immediately on retry

LLMGuard

Uses a secondary LLM call to review the tool handler arguments before execution. If the reviewer deems the call unsafe it raises GuardError with the reason.

from axio_tui_guards.guards import LLMGuard
from axio_transport_openai import OpenAITransport

reviewer = OpenAITransport(api_key="sk-...", model="gpt-4o-mini")
guard = LLMGuard(transport=reviewer)

Composing guards

Guards are applied in order — attach both for layered protection:

tool = Tool(
    name="shell",
    description="Run shell commands",
    handler=Shell,
    guards=(PathGuard(), LLMGuard(transport=reviewer)),
)

Custom guards

Implement the PermissionGuard protocol to write your own:

from axio.permission import PermissionGuard
from axio.exceptions import GuardError

class MyGuard(PermissionGuard):
    async def check(self, handler):
        if "rm -rf" in getattr(handler, "command", ""):
            raise GuardError("Refusing to run rm -rf")
        return handler

Plugin registration

[project.entry-points."axio.guards"]
path = "axio_tui_guards.guards:PathGuard"
llm  = "axio_tui_guards.guards:LLMGuard"

Part of the axio ecosystem

axio · axio-tui · axio-tui-rag

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

axio_tui_guards-0.4.0.tar.gz (86.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

axio_tui_guards-0.4.0-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file axio_tui_guards-0.4.0.tar.gz.

File metadata

  • Download URL: axio_tui_guards-0.4.0.tar.gz
  • Upload date:
  • Size: 86.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for axio_tui_guards-0.4.0.tar.gz
Algorithm Hash digest
SHA256 826e7c933b1e1e59ffe2f6099370fb07aebcbfb03cbdf6115839e9e0bcea2c03
MD5 90d5079605f59e98ab51391a3642e096
BLAKE2b-256 2109af0fd89b7fc39a979c9cb06cb2e78ae50e3f1d7a2878d69f0c3ea5262fc1

See more details on using hashes here.

Provenance

The following attestation bundles were made for axio_tui_guards-0.4.0.tar.gz:

Publisher: publish.yml on axio-agent/monorepo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file axio_tui_guards-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for axio_tui_guards-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2609525ebc0f324d846e79412f3fad4e93e114d9164a04e17907d454748685cb
MD5 0702e6b95fa4b4e745196da974bfee12
BLAKE2b-256 3080668d917e92d04997607d3cd47fb5f28e9c76193c4af42b43110d36a9b73f

See more details on using hashes here.

Provenance

The following attestation bundles were made for axio_tui_guards-0.4.0-py3-none-any.whl:

Publisher: publish.yml on axio-agent/monorepo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page