Skip to main content

A fully autonomous terminal AI agent — multi-model routing, persistent memory, real tool execution

Project description

English | 中文

🤖 PawnLogic

License: MIT Version PyPI CI Python 3.10+ Platform

A fully autonomous terminal AI agent — multi-model routing, persistent memory, real tool execution, and session management. Built for developers and security researchers.

System Requirements

  • Linux or WSL2
  • Python 3.10+
  • pip and git
  • ~/.local/bin in PATH if you want the global pawn command

⚡ Quick Start

Option A — pip install (recommended)

pip install pawnlogic
pawn   # first run launches the API configuration wizard

Option B — from source

git clone https://github.com/john0123412/PawnLogic.git && cd PawnLogic
python3 -m venv venv && source venv/bin/activate
pip install -e .
python main.py   # first run launches the API configuration wizard

Optional CTF skill pack (pwntools / ROPgadget / ropper + the skills/ctf_* markdown):

pip install -e ".[ctf]"

Global pawn command:

chmod +x pawn.sh && ln -sf "$(pwd)/pawn.sh" ~/.local/bin/pawn

If pawn is not found, run export PATH="$HOME/.local/bin:$PATH" and add that line to your shell profile.

CLI usage:

pawn                              # interactive mode
pawn --eval "your prompt"         # single execution then exit
pawn --eval "prompt" --json       # JSON output (for scripting)

What's New

See CHANGELOG.md for the full version history.

Key Capabilities

Capability Description
🔀 Dynamic Provider System Built-in DeepSeek / OpenAI / Anthropic + add any OpenAI-compatible API via /provider
🧠 Persistent Memory SQLite session history, RAG knowledge base, cross-session full-text search
🛠️ Real Tool Execution Shell, code sandbox (8 languages), web fetch, file ops, Docker containers
👁️ Vision Feed screenshots to gpt-4o or claude-sonnet for analysis
📋 Spec-Driven Planning Agent outputs <plan> XML before every action — no blind execution
💬 Session Management Tag, search, link, and export conversations with /chat commands
🔐 CTF / Pwn Toolchain GDB automation, ROP chain building, libc leak resolution, Docker isolation

Supported Models

Provider Aliases Best For
DeepSeek ds-v4-flash ds-v4-pro Fast default, flagship reasoning
OpenAI gpt-5.5 gpt-5.4 gpt-5.4-mini gpt-5.4-nano gpt-4o gpt-4.1 o3 Flagship, coding, vision, reasoning
Anthropic claude-opus claude-sonnet claude-haiku Frontier reasoning, balanced, fast

Custom providers added via /provider fetch appear automatically in /model and Tab completion.

Provider Management

/provider              # open interactive TUI panel
/provider add <name> <base_url> <ENV_KEY> [anthropic]
/provider fetch <name> # auto-discover models with interactive multi-select
/provider list         # show all providers and key status
/provider test <model> # test connectivity

All keys are stored in ~/.pawnlogic/.env. Provider configs (no keys) go to ~/.pawnlogic/custom_providers.json.

Quick Command Reference

/model [alias]          # switch model
/mode                   # toggle USER / DEV output mode
/chat find <keyword>    # full-text search across all sessions
/think <prompt>         # single deep-reasoning turn
/compact                # summarize + clear context
/undo [n]               # roll back last n turns
/deep                   # switch to deep mode (32k tokens, 50 iter)
/init_project           # initialize GSD engineering pipeline
/pwnenv                 # check CTF toolchain integrity
/keys                   # show API key status for all providers

MCP Tool Integration

cp mcp_configs.example.json ~/.pawnlogic/mcp_configs.json
# edit mcp_configs.json, add TAVILY_API_KEY= etc. to ~/.pawnlogic/.env
python main.py   # MCP servers load automatically

Supported MCP servers: Tavily (search), Playwright (browser automation), Filesystem (file bridge).

Data Layout

All runtime data and API keys are stored in ~/.pawnlogic/never in the project directory.

~/.pawnlogic/
├── .env                    # ALL API keys (LLM providers + MCP tools)
├── custom_providers.json   # user-added provider configs (no keys)
├── mcp_configs.json        # MCP server declarations
├── pawn.db                 # sessions, messages, knowledge base
├── global_skills.md        # GSA skill archive
├── workspace/              # per-session working directories
└── logs/                   # audit logs

The project directory contains no secrets and is safe to commit or share.

Documentation

Document Description
README.md This page
README_CN.md 中文版
GUIDE_EN.md Full reference — commands, architecture, FAQ
GUIDE_CN.md 完整参考手册 — 命令、架构、常见问题
CHANGELOG.md Version history and release notes
CONTRIBUTING.md How to contribute, add providers, run tests
SECURITY.md Vulnerability reporting policy

Support

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

pawnlogic-0.0.6.tar.gz (264.8 kB view details)

Uploaded Source

Built Distribution

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

pawnlogic-0.0.6-py3-none-any.whl (259.7 kB view details)

Uploaded Python 3

File details

Details for the file pawnlogic-0.0.6.tar.gz.

File metadata

  • Download URL: pawnlogic-0.0.6.tar.gz
  • Upload date:
  • Size: 264.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for pawnlogic-0.0.6.tar.gz
Algorithm Hash digest
SHA256 13f39a2bbda6ddc9bc3fdf987ce1a879ac44810521f70d4fb4ea33eec41dd55f
MD5 1f891164c160bb127e5a9172dc078152
BLAKE2b-256 9e8d0cc16f0a90057fc54c0f5bdd2c437d1a0ab2d9cacd6fd9a94b9fd85dd005

See more details on using hashes here.

File details

Details for the file pawnlogic-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: pawnlogic-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 259.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for pawnlogic-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 7ab929f7559622864de3d5cc4df45479f3e06b280ba8a202da7a7279c9a40196
MD5 b939118fc22e78aed49af38b884b023f
BLAKE2b-256 a3b89c358dc84871135aa3b5dfdd73665830f6885ca35fbc7ae39c3542b5786b

See more details on using hashes here.

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