命令行界面(CLI)为g4f系统在不同操作模式下运行提供了统一的入口点。本文档涵盖了CLI工具的结构、配置选项以及与核心系统组件的集成。有关底层API服务器实现的更多信息,请参阅FastAPI 端点。有关GUI服务器的详细信息,请参阅Web 界面。
g4f CLI围绕一个主入口点构建,该入口点使用Python的argparse子解析器分派到不同的操作模式。CLI支持两种主要模式:用于运行FastAPI服务器的API模式,以及用于运行Flask Web界面的GUI模式。
CLI入口点定义在main()函数中,该函数为不同模式创建子解析器,并根据所选模式分派到相应的运行器。
API模式提供了丰富的配置选项,用于运行FastAPI服务器,并可自定义提供商设置、身份验证选项和服务器参数。
| 参数 | 类型 | 默认 | 描述 |
|---|---|---|---|
--bind | 字符串 | 0.0.0.0:1337 | 服务器的绑定字符串 |
--port | int | None | 服务器端口覆盖 |
--debug | 标志 | 否 | 启用详细日志记录 |
--workers | int | None | 工作进程数量 |
--reload | 标志 | 否 | 启用自动重载 |
| 参数 | 类型 | 描述 |
|---|---|---|
--model | 字符串 | 聊天补全的默认模型 |
--provider | choice | 可用提供商中的默认提供商 |
--media-provider | choice | 图像生成的默认提供商 |
--ignored-providers | list | 要忽略的提供商列表 |
| 参数 | 类型 | 描述 |
|---|---|---|
--g4f-api-key | 字符串 | API访问的身份验证密钥 |
--ignore-cookie-files | 标志 | 不读取 .har 和 cookie 文件 |
--cookie-browsers | list | 用于cookie访问的浏览器列表 |
| 参数 | 类型 | 描述 |
|---|---|---|
--proxy | 字符串 | 默认代理配置 |
--ssl-keyfile | 字符串 | HTTPS的SSL密钥文件路径 |
--ssl-certfile | 字符串 | HTTPS的SSL证书文件路径 |
GUI模式提供了一组更简单的配置选项,侧重于Web界面托管和基本提供商管理。
| 参数 | 类型 | 默认 | 描述 |
|---|---|---|---|
--host | 字符串 | 0.0.0.0 | GUI服务器的主机名 |
--port | int | 8080 | GUI服务器的端口 |
--debug | 标志 | 否 | 启用调试模式 |
| 参数 | 类型 | 描述 |
|---|---|---|
--ignored-providers | list | 要忽略的提供商列表 |
--ignore-cookie-files | 标志 | 不读取 .har 和 cookie 文件 |
--cookie-browsers | list | 用于cookie访问的浏览器列表 |
CLI通过配置对象和系统初始化与g4f核心系统集成。下图展示了CLI参数如何流入系统配置
run_api_args()函数处理CLI参数并通过以下几个步骤配置系统
AppConfig.set_config()设置应用程序范围的配置run_api()run_gui_args()函数处理GUI特定的配置
run_gui()CLI是用户配置与g4f系统核心组件之间的主要接口
来源:g4f/cli.py1-84 g4f/gui/gui_parser.py1-16 g4f/gui/run.py1-28