Assistant 开源项目使用教程

Assistant 开源项目使用教程

assistant Simple, extensible and powerful one stop personal assistant 项目地址: https://gitcode.com/gh_mirrors/assist/assistant

1. 项目介绍

Assistant 是一个简单、可扩展且功能强大的个人助手项目，类似于你的 Shell，但具有 HTML 的强大功能。它由多个调度器（处理器）和卡片组成，调度器处理文本命令，然后将结果放入结果通道，Assistant 将使用相应的卡片（Om 组件）来显示数据。

2. 项目快速启动

2.1 环境准备

确保你已经安装了 Leiningen，如果没有安装，可以使用以下命令进行安装：

brew install leiningen

注意：如果你使用的是较旧版本的 Leiningen，请升级到 2.5.3 或更高版本。

2.2 克隆项目

克隆 Assistant 项目到本地：

git clone git@github.com:29decibel/assistant.git
cd assistant

2.3 构建项目

使用以下命令构建项目：

lein cljsbuild once
lein node-webkit-build

构建完成后，你将在 release 文件夹中找到一个独立的应用程序。目前，它仅支持 Mac 系统，未来将支持 Linux 和 Windows。

2.4 配置文件

确保你在 ~/assistant 中有适当的配置文件。你可以在这里找到一个示例配置文件：

cp dot_assistant_example ~/.assistant

3. 应用案例和最佳实践

3.1 自定义插件

你可以编写自己的处理器和卡片来扩展 Assistant 的功能。以下是一个简单的处理器示例，它向 Jira API 发出请求，然后将 JSON 响应放入通道中，并告诉 Assistant 使用 Jira 卡片来渲染结果。

(defn jira-dispatcher [result-chan text]
  (go
    (let [response (<p! (http/get (str endpoint "/rest/api/2/issue/" text)
                                  [:basic-auth [:username username :password password]]))
          m (:body response)
          error (:errorMessages m)
          issue-key (:key m)]
      (when issue-key
        (>p! result-chan [:type :jira :content m :input text])))))

3.2 注册插件

将你的插件命名空间添加到 ~/.assistant-plugins 文件中：

echo "assistant.plugins.your_awesome_plugin" >> ~/.assistant-plugins

4. 典型生态项目

4.1 天气插件

你可以集成天气插件来显示当前天气信息。参考项目：erikflowers/weather-icons。

4.2 电影放映时间插件

集成电影放映时间插件，显示电影放映时间。参考项目：developer.fandango.com/io-docs。

4.3 酒店价格搜索插件

集成酒店价格搜索插件，帮助用户查找酒店价格。参考项目：developer.ean.com/docs/common。

通过这些插件，你可以扩展 Assistant 的功能，使其更加强大和实用。

assistant Simple, extensible and powerful one stop personal assistant 项目地址: https://gitcode.com/gh_mirrors/assist/assistant