尤达个人助理

命令行上的个人助理。

安装

pip install yodapa

yoda --help

配置尤达

yoda configure

插件

尤达设计为可扩展的。你可以编写自己的插件，也可以让 AI 为你生成一个。

列出插件

使用 --help 命令可以列出所有可用的插件。

❯ yoda --help
                                                                            
 使用方法：yoda [选项] 命令 [参数]...                                    
                                                                            
╭─ 选项 ────────────────────────────────────────────────────────────────╮
│ --install-completion          安装当前 shell 的补全功能。  │
│ --show-completion             显示当前 shell 的补全脚本，以便复制或自定义安装。     │
│ --help                        显示此消息并退出。                │
╰──────────────────────────────────────────────────────────────────────────╯
╭─ 命令 ───────────────────────────────────────────────────────────────╮
│ ai       AI 命令。允许你与本地 LLM 对话      │
│ config   配置管理                                               │
│ dev                                                                      │
│ init     初始化尤达配置                                        │
│ plugin   管理插件的命令                                      │
│ url                                                                      │
╰──────────────────────────────────────────────────────────────────────────╯

你可以通过 --help 标志查看每个插件的详细信息。以下是一些示例：

❯ yoda ai --help
                                                                            
 使用方法：yoda ai [选项] 命令 [参数]...                                 
                                                                            
 AI 命令。允许你与本地 LLM 交流                 
                                                                            
╭─ 选项 ────────────────────────────────────────────────────────────────╮
│ --help          显示此消息并退出。                              │
╰──────────────────────────────────────────────────────────────────────────╯
╭─ 命令 ───────────────────────────────────────────────────────────────╮
│ chat               根据提供的提示与 AI 模型聊天。  │
│ generate-command   根据提供的提示生成新插件命令的代码。                                      │
╰──────────────────────────────────────────────────────────────────────────╯

❯ yoda dev --help
                                                                            
 使用方法：yoda dev [选项] 命令 [参数]...                                
                                                                            
╭─ 选项 ────────────────────────────────────────────────────────────────╮
│ --help          显示此消息并退出。                              │
╰──────────────────────────────────────────────────────────────────────────╯
╭─ 命令 ───────────────────────────────────────────────────────────────╮
│ checksite          检查网站是否正常运行                     │
│ coinflip           抛硬币！                                          │
│ generatepassword   生成安全密码                           │
│ speedtest          测试你的互联网连接                         │
│ whois              查询域名的 WHOIS 信息                    │
╰──────────────────────────────────────────────────────────────────────────╯

为尤达编写自己的插件

只需创建一个带有 @yoda_plugin(name="plugin-name") 装饰器的类，并为其添加方法。非私有方法将自动作为子命令添加到尤达中，命令名称即为你提供给装饰器的名称。

import typer

app = typer.Typer(help="""
    欢迎插件。打个招呼。

    示例：

        $ yoda hi hello --name MP

        $ yoda hi hello
    """)


@app.command()
def hello(name: str = None):
    """打招呼。"""
    name = name or "学徒"
    typer.echo(f"你好 {name}!")

使用 AI 生成自己的插件

$ yoda ai generate-command weather "显示指定位置的天气"

🤖 生成的代码：

import requests
from typing import Optional

app = typer.Typer(help="""
    显示给定位置的天气。

    示例：

        $ yoda weather London

        $ yoda weather -l London
    """)

@app.command()
def weather(location: str, units: Optional[str] = None):
    """显示给定位置的当前天气。"""
    # 在这里设置你的 API 密钥或数据库连接
    api_key = "YOUR_API_KEY"
    db_conn = None  # 在这里初始化你的数据库连接
    
    # 使用 requests 库向 API 发送 HTTP 请求
    url = f"https://api.openweathermap.org/data/2.5/weather?q={location}&appid={api_key}"
    response = requests.get(url)
    
    # 如果响应成功，解析 JSON 数据并以 typer 可显示的格式返回
    if response.status_code == 200:
        data = response.json()
        temperature = data["main"]["temp"]
        humidity = data["main"]["humidity"]
        wind = data["wind"]["speed"]
        pressure = data["main"]["pressure"]
        
        typer.echo(f"{location} 的天气情况：")
        typer.echo(f"\t温度：{temperature}°C")
        typer.echo(f"\t湿度：{湿度}%")
        typer.echo(f"\t风速：{风速} m/s")
        typer.echo(f"\t气压：{压力} hPa")
        
    # 如果响应不成功，打印错误信息
    else：
        typer.echo(f"错误：{response.status_code}")

或者与尤达聊天：

❯ yoda ai chat "你好吗？"
🤖 AI 回答：
我很好，年轻人。原力在我体内很强大。

开发环境搭建

# 1. 从他们的官网安装 poetry：https://python-poetry.org/docs/#installation

# 2. 安装依赖和本包
poetry install

# 3. 激活虚拟环境
poetry shell

# 现在你应该可以与 yoda 交互了
yoda --help

测试

# 在虚拟环境中运行测试
pytest

Yoda PA 快速上手指南

Yoda 是一款运行在命令行界面的个人助理工具，支持本地大语言模型（LLM）交互、插件扩展及实用开发命令。

环境准备

• 操作系统：Linux / macOS / Windows (WSL)
• Python 版本：建议 Python 3.8 及以上
• 前置依赖：
  • pip (Python 包管理工具)
  • 可选：poetry (仅用于二次开发或贡献代码)

💡 国内加速建议：如遇安装缓慢，可使用清华或阿里镜像源加速 pip 安装：

pip install yodapa -i https://pypi.tuna.tsinghua.edu.cn/simple

安装步骤

1. 安装 Yoda

   pip install yodapa
   

2. 验证安装并查看帮助

   yoda --help
   

3. 初始化配置 首次使用前需运行配置向导：

   yoda configure
   

   或者使用初始化命令：

   yoda init
   

基本使用

安装完成后，你可以通过内置插件立即开始使用。

1. 与 AI 对话

利用本地连接的 LLM 进行聊天：

yoda ai chat "你好，请介绍一下你自己"

2. 使用实用工具命令

Yoda 内置了多种开发常用小工具（位于 dev 模块）：

• 生成安全密码：

  yoda dev generatepassword
  

• 测试网速：

  yoda dev speedtest
  

• 检查网站状态：

  yoda dev checksite https://www.example.com
  

3. 让 AI 帮你写插件

你可以直接让 Yoda 根据需求生成新的插件代码。例如，生成一个查询天气的命令：

yoda ai generate-command weather "show weather for the provided location"

系统将输出完整的 Python 代码，你可将其保存为插件文件即可使用。

4. 查看所有可用命令

随时输入以下命令查看当前所有可用的插件和功能列表：

yoda --help