Cannoli 开源项目安装与使用教程

Cannoli 开源项目安装与使用教程

cannoli Cannoli allows you to build and run no-code LLM scripts using the Obsidian Canvas editor. 项目地址: https://gitcode.com/gh_mirrors/cann/cannoli

Cannoli 是一个允许用户无需编码即可构建和运行低代码或无代码 LLM（大型语言模型）脚本的工具，特别集成了Obsidian Canvas编辑器，使得逻辑设计直观如同绘制流程图一般。

1. 项目目录结构及介绍

Cannoli 的项目结构组织如下：

• github/workflows: 包含GitHub Actions的工作流文件，用于自动化项目的持续集成/持续部署(CI/CD)过程。
• vscode: 提供VS Code相关的配置或者扩展支持。
• .editorconfig: 确保跨编辑器的一致性设置。
• .env, .eslintignore, .eslintrc, .gitignore, .npmignore, .npmrc, .nvmrc: 这些是常见的环境变量、ESLint忽略规则、ESLint配置、Git忽略文件、npm忽略文件、npm配置以及Node版本管理配置文件。
• DEVELOPMENT.md: 开发者指南，包含了如何参与项目开发的说明。
• LICENSE: 许可证文件，表明该项目遵循MIT许可协议。
• README.md: 项目的简介和快速入门指南。
• manifest.json: 插件元数据，定义了插件的基本信息。
• package.json, pnpm-lock.yaml, pnpm-workspace.yaml: 依赖管理和工作区配置，用于npm或pnpm包管理。
• styles.css: 包含项目所需的CSS样式。
• turbo.json, version-bump.mjs, versions.json: 版本管理相关的配置文件。
• 在根目录下还可能有具体的脚本文件或配置，用于项目的不同功能实现。

2. 项目的启动文件介绍

Cannoli作为基于Obsidian的插件，其启动并不像传统意义上的服务器应用那样有一个直接的“启动文件”。它通过Obsidian内部机制触发执行。主要交互点包括点击Cannoli控制条图标、命令调色板中的“Start/Stop cannoli”命令、或通过特定命名的Canvas文件(*.cno)进行。对于开发者来说，若需调试或启动相关后端服务（如自定义Ollama服务），则需查阅DEVELOPMENT.md文件内的指示来手动启动或配置必要的服务。

3. 项目的配置文件介绍

Cannoli的主要配置不直接表现为单一的配置文件，而是结合了多个方面：

• 个人偏好和API设置：通常在Obsidian插件设置中进行调整，这里可以设置默认的LLM提供商（如OpenAI, Groq等）、编辑个别服务的设置，并在需要时覆盖默认的AI提供者。
• 环境变量：对于本地Ollama服务的使用者，需要配置OLLAMA_ORIGINS环境变量以允许来自Obsidian桌面客户端的请求，具体配置方式因操作系统而异，例如，在Mac OS中通过终端命令launchctl setenv OLLAMA_ORIGINS "*"并重启Ollama服务。
• Cannoli脚本配置：在Canvas编辑器内，通过卡片和箭头的配置实现逻辑设定，这虽然不是传统的文本配置文件，但每个节点和箭头的配置都构成了运行逻辑的一部分。

总之，Cannoli项目通过高度集成的方式运作，大部分配置和启动流程依赖于Obsidian环境和插件系统，而非独立的启动文件和配置文件。因此，深入理解和操作该插件涉及在Obsidian的环境下进行一系列的设置和脚本设计。

cannoli Cannoli allows you to build and run no-code LLM scripts using the Obsidian Canvas editor. 项目地址: https://gitcode.com/gh_mirrors/cann/cannoli