README
🚀 Lilith-shell 项目说明
Lilith-shell 是一款强大的工具,可在 Claude Desktop 里借助自定义 shell 环境执行命令。它源自 Pandora-shell 分支,在安全性、测试性和功能性上都有显著提升。
🚀 快速开始
Lilith-shell 能让你在 Claude Desktop 中便捷执行命令,下面为你介绍使用前的准备工作。
📦 安装指南
项目克隆与依赖安装
- 克隆项目仓库:
git clone https://github.com/yourusername/Lilith-Shell.git cd Lilith-Shell - 创建并激活虚拟环境(推荐):
- 对于 macOS/Linux 系统:
python -m venv venv source venv/bin/activate - 对于 Windows 系统:
python -m venv venv .\venv\Scripts\activate
- 对于 macOS/Linux 系统:
- 安装依赖项:
pip install -r requirements.txt
📚 详细文档
配置指南
项目路径设置
要确保把 Lilith-Shell 项目的完整路径添加到系统的环境变量中。
环境变量配置
编辑或创建以下文件,依据你的操作系统来选择:
Windows 系统
- 打开
System Environment Variables。 - 添加或修改以下变量:
- Path: 把
%APPDATA%\Lilith-Shell\bin添加到系统路径里。
- Path: 把
macOS/Linux 系统
- 打开终端并编辑
.bashrc或.zshrc文件:nano ~/.bashrc - 在文件末尾添加以下内容:
export PATH=$PATH:/path/to/Lilith-Shell/bin - 保存并退出,接着运行
source ~/.bashrc让配置生效。
使用指南
启动服务
在项目的根目录启动 Lilith-shell 服务:
# 对于 macOS/Linux 系统:
python src/lilith_shell/executor.py
# 对于 Windows 系统:
.\venv\Scripts\python.exe src\lilith_shell\executor.py
示例命令
- 查询当前工作目录:
Can you run 'pwd' and tell me what directory we're in? - 列出用户主目录中的文件,并筛选出大于 200 MB 的文件:
Can you list the files in my home directory? Which of them are larger than 200 MB?
安全注意事项
Lilith-shell 会以用户权限执行命令。为保障安全,请遵循以下建议:
- 仅在受信任的环境中使用:
- 采用虚拟机(VM)或一次性开发环境。
- 禁止在生产系统或存储敏感数据的设备上使用。
- 实施命令限制:
- 配置白名单策略,允许特定命令执行。
- 定期审查和更新允许的命令列表。
- 监控系统活动:
- 利用系统监控工具跟踪用户活动。
- 定期审计日志文件以检测异常行为。
- 数据备份:
- 定期备份重要数据,以防意外情况发生。
故障排除
服务启动失败
- 检查是否有其他进程占用相同端口。
- 查看错误日志获取更多信息:
tail -f logs/error.log
网络连接问题
- 确保防火墙规则允许相关端口通信。
- 检查网络配置,保证服务可访问互联网。
致谢与参考文献
- Pandora-shell:Lilith-shell 的基础项目,提供了众多核心功能和代码实现。
- Python 官方文档:用于理解虚拟环境和依赖管理的相关知识。
- 社区和技术论坛:感谢开源社区的技术支持和讨论。
通过上述步骤,你就能顺利使用 Lilith-shell 项目,并依据具体需求进行定制和扩展。若有任何问题或建议,请随时联系项目维护人员。
Scan to join WeChat group