magic-cli 学习资料汇总 - 基于大语言模型的命令行工具

magic-cli 简介

magic-cli 是一个基于大语言模型(LLM)的命令行工具,旨在帮助用户更高效地使用命令行。它的主要功能包括:

• 根据提示生成命令建议
• 语义搜索用户的命令历史
• 根据任务描述生成相应的命令
• 支持本地或远程 LLM

magic-cli 的灵感来源于 Amazon Q(前身是 Fig terminal)和 GitHub Copilot for CLI 等项目。它使用 orch 库来处理与 LLM 的交互,包括执行、编排和模型对齐等。

安装方法

magic-cli 提供了多种安装方式:

1. 使用 Shell 安装:

curl -LsSf https://github.com/guywaldman/magic-cli/releases/download/0.0.6/magic-cli-installer.sh | sh

2. 通过 Homebrew 安装:

brew install guywaldman/tap/magic-cli

3. 使用 PowerShell 安装:

powershell -c "irm https://github.com/guywaldman/magic-cli/releases/download/0.0.6/magic-cli-installer.ps1 | iex"

4. 下载二进制文件:

   访问 releases 页面 下载适合你平台的二进制文件。

使用方法

magic-cli 提供了多个子命令,主要包括:

1. suggest: 根据提示生成命令建议
2. search: 搜索命令历史
3. ask: 根据任务描述生成命令

命令建议

使用 suggest 子命令来获取命令建议:

magic-cli suggest "Resize test_image.png to 300x300 with ffmpeg"

搜索命令历史

使用 search 子命令来搜索你的命令历史:

magic-cli search "zellij attach"

生成命令

使用 ask 子命令来根据任务描述生成命令:

magic-cli ask "Set up the dev environment as described in the README"

配置

magic-cli 的配置文件位于 ~/.config/magic_cli/config.json。你可以使用 magic-cli config 命令来管理配置选项。主要的配置选项包括:

• LLM 提供商选择 (ollama 或 OpenAI)
• 模型参数设置
• 命令建议模式等

学习资源

1. 官方 GitHub 仓库: 包含最新的源码和文档
2. 发布公告博客: 介绍了 magic-cli 的背景和设计思路
3. orch 库文档: magic-cli 使用的 LLM 交互库
4. CONTRIBUTING.md: 如何为项目贡献代码
5. SECURITY.md: 安全相关信息和漏洞报告指南

magic-cli 仍处于早期开发阶段,欢迎社区贡献和反馈。使用过程中如遇到任何问题,请在 GitHub 仓库提交 issue。

通过学习和使用 magic-cli,你可以大大提高命令行操作的效率,让 AI 成为你的得力助手。无论是日常工作还是开发任务,magic-cli 都能为你带来全新的命令行体验。