Skip to main content

A powerful AI agent with skills system

Project description

QRClaw

PyPI version Python License: MIT

A powerful AI agent with skills system

English | 中文


English

Features

  • 🤖 AI Agent - Powered by OpenAI, with intelligent context management
  • 🎯 Skills System - Extend functionality with modular skills
  • 🔄 OpenClaw Compatible - Fully compatible with OpenClaw skills ecosystem
  • 💾 Session Management - Persistent conversation history
  • 🎨 Rich UI - Beautiful terminal interface with syntax highlighting
  • 📦 Easy to Use - Simple installation and configuration

Installation

# Install from PyPI
pip install qrclaw

# Or install from GitHub
pip install git+https://github.com/fu-qingrong/qrclaw.git

Quick Start

  1. Set up API Key

    # Create .env file
    echo "OPENAI_API_KEY=your-api-key-here" > ~/.qrclaw/.env
    
  2. Run QRClaw

    qrclaw
    
  3. Start Chatting

    > Hello, how can you help me?
    > Analyze this project for me
    > Review the code in src/main.py
    

Skills System

QRClaw comes with built-in skills:

  • review-code - Review code and provide improvement suggestions
  • generate-docs - Generate README, API docs, etc.
  • analyze-project - Analyze project structure and code quality
  • install-skill - Install new skills from GitHub/ClawHub

Install New Skills

# In QRClaw chat
> 导入 skill meow-finder

# Or use CLI
/skill import meow-finder

Configuration

Configuration file: ~/.qrclaw/config

[DEFAULT]
model = gpt-4o-mini
max_tokens = 128000
log_level = INFO

Commands

  • exit - Exit QRClaw
  • clear - Clear conversation history
  • /skill list - List installed skills
  • /skill import <name> - Import a new skill

Development

# Clone repository
git clone https://github.com/fu-qingrong/qrclaw.git
cd qrclaw

# Create virtual environment
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate

# Install dependencies
pip install -e .

# Run
python -m qrclaw.cli

中文

特性

  • 🤖 AI 代理 - 基于 OpenAI,智能上下文管理
  • 🎯 技能系统 - 模块化技能扩展功能
  • 🔄 OpenClaw 兼容 - 完全兼容 OpenClaw 技能生态
  • 💾 会话管理 - 持久化对话历史
  • 🎨 精美界面 - 终端界面美观,支持语法高亮
  • 📦 易于使用 - 简单安装和配置

安装

# 从 PyPI 安装
pip install qrclaw

# 或从 GitHub 安装
pip install git+https://github.com/fu-qingrong/qrclaw.git

快速开始

  1. 设置 API Key

    # 创建 .env 文件
    echo "OPENAI_API_KEY=your-api-key-here" > ~/.qrclaw/.env
    
  2. 运行 QRClaw

    qrclaw
    
  3. 开始对话

    > 你好,你能帮我做什么?
    > 帮我分析一下这个项目
    > 审查 src/main.py 的代码
    

技能系统

QRClaw 内置技能:

  • review-code - 代码审查和改进建议
  • generate-docs - 生成 README、API 文档等
  • analyze-project - 分析项目结构和代码质量
  • install-skill - 从 GitHub/ClawHub 安装新技能

安装新技能

# 在 QRClaw 对话中
> 导入 skill meow-finder

# 或使用 CLI
/skill import meow-finder

配置

配置文件:~/.qrclaw/config

[DEFAULT]
model = gpt-4o-mini
max_tokens = 128000
log_level = INFO

命令

  • exit - 退出 QRClaw
  • clear - 清除对话历史
  • /skill list - 列出已安装技能
  • /skill import <name> - 导入新技能

开发

# 克隆仓库
git clone https://github.com/fu-qingrong/qrclaw.git
cd qrclaw

# 创建虚拟环境
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate

# 安装依赖
pip install -e .

# 运行
python -m qrclaw.cli

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Acknowledgments

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

qrclaw-0.5.0.tar.gz (48.3 kB view details)

Uploaded Source

Built Distribution

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

qrclaw-0.5.0-py3-none-any.whl (58.5 kB view details)

Uploaded Python 3

File details

Details for the file qrclaw-0.5.0.tar.gz.

File metadata

  • Download URL: qrclaw-0.5.0.tar.gz
  • Upload date:
  • Size: 48.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for qrclaw-0.5.0.tar.gz
Algorithm Hash digest
SHA256 d7afa34207ce825a838dbc96845553ee927b2614f0c2330281b76e6b56f3a47f
MD5 6c193c7d66c62a0c6d3582064e9f9a24
BLAKE2b-256 b30bc2aa36ec8b4fe7439adb0ee93ae193533251e52fbabfd416fc7fa93fa9e1

See more details on using hashes here.

File details

Details for the file qrclaw-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: qrclaw-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 58.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for qrclaw-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dbe8d8991e2acb645d44fcb135881ef61a8de67ecba28fd5ca4698ab63cdeae0
MD5 3fb81d2d119a2f26e718eb0446c9e88a
BLAKE2b-256 dbd06dd02590d9b670e43875b22f0ab9dc5fdfbeef4e26ad2fc7d56e94cae23f

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