Skip to main content

Command-line agent

Project description

GG CLI - 大模型命令行工具

一个功能强大的命令行大模型工具,支持多种LLM提供商,提供交互式聊天和终端命令执行功能。

✨ 特性

  • 💬 交互式聊天: 提供流畅的命令行聊天体验
  • 终端集成: 内置终端命令执行功能,支持跨平台

📦 安装

从PyPI安装(更新中)

pip install gg-cli

🚀 快速开始

1. 首次配置

# 添加LLM配置
gg add
# 跟随向导完成配置
# 您需要获取大模型服务商的 url 和 api_key

# 添加完成后,使用list查看配置
gg list

2. 开始聊天

# 交互式聊天模式
gg

# 发送单条消息
gg "你好,请介绍一下自己"

📖 使用指南

配置管理

添加配置

gg add

交互式添加新的LLM配置,包括:

  • name: 配置标识名称(可选,默认为当前日期)
  • api_key: API密钥(必需)
  • base_url: API基础URL(默认:https://api.openai.com/v1)
  • model: 模型名称(必需)
  • temperature: 温度参数0.0-2.0(默认:0.7)

查看配置

gg list

显示所有已保存的LLM配置信息。

更新配置

gg update

交互式更新现有配置(除名称外)。

删除配置

gg delete

删除指定的LLM配置。

设置默认配置

gg default

从现有配置中选择一个设为默认LLM。

聊天模式

交互式聊天

gg

启动交互式聊天模式,支持:

  • 连续对话
  • 终端命令执行
  • 多轮对话上下文保持

退出聊天

在聊天模式中输入以下任一命令退出:

  • \q\quit
  • \e\exit
  • Ctrl+C

终端功能

GG CLI集成了强大的终端功能:

  • 命令执行: 支持执行系统命令
  • 跨平台: 自动适配Windows PowerShell、Linux Bash、macOS Zsh
  • 安全确认: 执行命令前需要用户确认
  • 实时输出: 实时显示命令执行结果
  • 错误处理: 完善的错误处理和超时机制

🔧 配置说明

配置文件位置

  • Windows: %APPDATA%\gg-cli\gg-cli\config.enc
  • Linux/macOS: ~/.config/gg-cli/config.enc

支持的LLM提供商

提供商 Base URL 示例模型
OpenAI https://api.openai.com/v1 gpt-4, gpt-3.5-turbo
阿里云通义千问 https://dashscope.aliyuncs.com/compatible-mode/v1 qwen-max, qwen-plus
其他兼容OpenAI API的服务 自定义 自定义

📋 系统要求

  • Python 3.12+
  • 支持的操作系统:Windows、Linux、macOS
  • 网络连接(用于API调用)

🛠️ 开发

项目结构

gg-cli/
├── gg_main.py      # 主程序入口
├── llm.py          # LLM核心功能
├── file.py         # 配置文件管理
├── pyproject.toml  # 项目配置
└── README.md       # 说明文档

依赖项

  • openai>=1.102.0: OpenAI API客户端
  • requests>=2.32.5: HTTP请求库
  • appdirs>=1.4.4: 跨平台应用目录管理

🤝 贡献

欢迎提交Issue和Pull Request!

作者邮箱:241098038@smail.nju.edu.cn

📄 许可证

本项目采用MIT许可证。

🔗 相关链接


注意: 使用前请确保已获得相应LLM提供商的API访问权限。

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

gg_cli-0.1.0.tar.gz (27.2 kB view details)

Uploaded Source

Built Distribution

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

gg_cli-0.1.0-py3-none-any.whl (31.9 kB view details)

Uploaded Python 3

File details

Details for the file gg_cli-0.1.0.tar.gz.

File metadata

  • Download URL: gg_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 27.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for gg_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 faec7e505c9eeaa17385ff872ccb16776ff5439b01c0cd6cd3fdfc41c5ac0329
MD5 cd64d7c6eca690cbac5859239f6834dd
BLAKE2b-256 a3b353656e638b8a805eb24a9f4fc6ff2279f1bbeefe8f92275d173a74cbafb0

See more details on using hashes here.

File details

Details for the file gg_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: gg_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 31.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for gg_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 33c4155630b507c857482394084aadda292e3b3830ff8adcb024969341427ca9
MD5 c3484183c4727fab4d6a0753799795ec
BLAKE2b-256 590050b24bff25f5105f742253e56ba33b13512c1a1788cff18190a6058ffb34

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