deepfish-ai 1.0.8 → 1.0.12

package/README.md

@@ -1,6 +1,5 @@
 <div align="center" style="display:flex;align-items: center;justify-content: center;">
-  <img src="./images/logo2.png" alt="DeepFish" style="width:55px;" />
-  <span style="font-size: 30px;font-weight: bold;color:#3386FE">DeepFish</span>
+  <img src="./images/title-img.png" alt="DeepFish" width="300" />
 </div>
 
 ---
@@ -25,13 +24,44 @@
   />
 </div>
 
-<img src="./images/banner.png" alt="AI Command Line Tool Screenshot" style="width:100%;text-align:center;" />
+<img src="./images/banner.png" alt="banner" style="width:100%;text-align:center;" />
 
 
 
 - [English](README.md) | [中文](README_CN.md)
 
-[TOC]
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [1. Introduction](#1-introduction)
+- [2. Installation](#2-installation)
+  - [Prerequisites](#prerequisites)
+  - [Installation via npm](#installation-via-npm)
+  - [Installation from Source](#installation-from-source)
+- [3. Quick Start](#3-quick-start)
+- [4. Configuration](#4-configuration)
+  - [Initial Setup](#initial-setup)
+  - [Configuration Commands](#configuration-commands)
+  - [Configuration File Structure](#configuration-file-structure)
+- [5. Usage](#5-usage)
+  - [Interactive Mode](#interactive-mode)
+  - [Direct Command Mode](#direct-command-mode)
+  - [Usage Examples](#usage-examples)
+- [6. Extension Development](#6-extension-development)
+  - [Creating an Extension](#creating-an-extension)
+  - [Registering Extensions](#registering-extensions)
+- [7. Recommendations](#7-recommendations)
+  - [AI Service Selection](#ai-service-selection)
+- [8. Usage Notes](#8-usage-notes)
+  - [Using Relative Paths](#using-relative-paths)
+- [9. Troubleshooting](#9-troubleshooting)
+  - [Configuration Issues](#configuration-issues)
+  - [AI Service Connection](#ai-service-connection)
+  - [Extension Not Loading](#extension-not-loading)
+- [10. Contributing](#10-contributing)
+- [11. License](#11-license)
+- [12. Support](#12-support)
+
 
 
 ## 1. Introduction
@@ -66,7 +96,7 @@ npm install -g deepfish-ai
 ### Installation from Source
 
 ```bash
-git clone https://github.com/qq306863030/deepfish.git
+git clone https://github.com/qq306863030/deepfish-ai.git
 cd deepfish
 npm install
 npm link
@@ -259,7 +289,7 @@ module.exports = {
 };
 ```
 
-#### Registering Extensions
+### Registering Extensions
 
 **Method 1: Using Command Line**
 
@@ -284,11 +314,18 @@ module.exports = {
 
 **Method 3: Automatic Scanning**
 
-The program automatically scans the following directories for directories starting with "deepfish-" on startup.
-1. The npm global node_modules directory (extensions can be installed via `npm install -g deepfish-xxx`)
-2. The node_modules directory in the current working directory
-3. The current working directory
+Rules for automatic scanning of extension modules upon program startup:
+
+1. Scanning locations:
+   - node_modules in the root directory
+   - node_modules in the command execution directory
+   - the command execution directory itself
 
+2. Scanned files:
+   - Extension packages under the @deepfish-ai directory
+   - Extension packages starting with "deepfish-"
+   - JavaScript extension files in the command execution directory, which are automatically loaded if they contain the strings 'module.exports', 'descriptions', and 'functions'
+  
 ## 7. Recommendations
 
 ### AI Service Selection

package/README_CN.md

@@ -1,6 +1,5 @@
 <div align="center" style="display:flex;align-items: center;justify-content: center;">
-  <img src="./images/logo2.png" alt="DeepFish" style="width:55px;" />
-  <span style="font-size: 30px;font-weight: bold;color:#3386FE">DeepFish</span>
+  <img src="./images/title-img.png" alt="DeepFish" width="300" />
 </div>
 
 ---
@@ -25,15 +24,44 @@
   />
 </div>
 
-<img src="./images/banner.png" alt="AI 命令行工具截图" style="width:100%;text-align:center;" />
+<img src="./images/banner.png" alt="banner" style="width:100%;text-align:center;" />
 
 
 
 
 - [English](README.md) | [中文](README_CN.md)
 
-[TOC]
-
+## 目录
+
+- [目录](#目录)
+- [1. 介绍](#1-介绍)
+- [2. 安装](#2-安装)
+  - [前置要求](#前置要求)
+  - [通过npm安装](#通过npm安装)
+  - [从源码安装](#从源码安装)
+- [3. 快速使用](#3-快速使用)
+- [4. 配置](#4-配置)
+  - [初始设置](#初始设置)
+  - [配置命令](#配置命令)
+  - [配置文件结构](#配置文件结构)
+- [5. 使用方法](#5-使用方法)
+  - [交互模式](#交互模式)
+  - [直接命令模式](#直接命令模式)
+  - [使用示例](#使用示例)
+- [6. 扩展开发](#6-扩展开发)
+  - [创建扩展](#创建扩展)
+  - [注册扩展](#注册扩展)
+- [7. 建议](#7-建议)
+  - [AI服务选择](#ai服务选择)
+- [8. 使用说明](#8-使用说明)
+  - [使用相对路径](#使用相对路径)
+- [9. 故障排除](#9-故障排除)
+  - [配置问题](#配置问题)
+  - [AI服务连接](#ai服务连接)
+  - [扩展未加载](#扩展未加载)
+- [10. 贡献](#10-贡献)
+- [11. 许可证](#11-许可证)
+- [12. 支持](#12-支持)
 
 ## 1. 介绍
 
@@ -66,7 +94,7 @@ npm install -g deepfish-ai
 ### 从源码安装
 
 ```bash
-git clone https://github.com/qq306863030/deepfish.git
+git clone https://github.com/qq306863030/deepfish-ai.git
 cd deepfish
 npm install
 npm link
@@ -259,7 +287,7 @@ module.exports = {
 };
 ```
 
-#### 注册扩展
+### 注册扩展
 
 **方法1：使用命令行**
 
@@ -284,10 +312,15 @@ module.exports = {
 
 **方法3：自动扫描**
 
-程序启动时会自动扫描以下目录中以“deepfish-”开头的目录。
-1.程序npm全局node_modules目录(扩展可通过"npm install -g deepfish-xxx" 安装)
-2.当前工作目录中的node_modules目录
-3.当前工作目录
+程序启动时自动扫描扩展模块的规则:
+1. 扫描位置:
+    - 根目录的node_modules
+    - 命令执行目录的node_modules
+    - 命令执行目录
+2. 扫描文件:
+    - @deepfish-ai目录下的扩展包
+    - deepfish-开头的扩展包
+    - 命令执行目录的js扩展文件，js文件内包含'module.exports'、'descriptions'和'functions'字符串则视为扩展文件自动加载
 
 ## 7. 建议
 

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "deepfish-ai",
-  "version": "1.0.8",
-  "description": "An AI command-line tool that converts natural language instructions into operating system commands and file operations, supporting Ollama, DeepSeek, and other models compatible with the OpenAI API specification.",
+  "version": "1.0.12",
+  "description": "This is an AI-driven command-line tool built on Node.js, equipped with AI agent and workflow capabilities. It is compatible with a wide range of AI models, can convert natural language into cross-system terminal and file operation commands, and features high extensibility. It supports complex tasks such as translation, content creation, and format conversion, while allowing custom extensions to be automatically generated via AI.",
   "main": "src/index.js",
   "bin": {
-    "ai": "src/cli.js"
+    "ai": "src/cli/index.js"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -12,6 +12,8 @@
   "keywords": [
     "ai",
     "deepseek",
+    "agent",
+    "assistant",
     "cli",
     "command-line",
     "cmd",
@@ -23,12 +25,12 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/qq306863030/deepfish.git"
+    "url": "https://github.com/qq306863030/deepfish-ai.git"
   },
   "bugs": {
-    "url": "https://github.com/qq306863030/deepfish/issues"
+    "url": "https://github.com/qq306863030/deepfish-ai/issues"
   },
-  "homepage": "https://github.com/qq306863030/deepfish#readme",
+  "homepage": "https://github.com/qq306863030/deepfish-ai#readme",
   "dependencies": {
     "axios": "^1.13.5",
     "chalk": "^4.1.0",
@@ -53,4 +55,4 @@
     "README_CN.md",
     "LICENSE"
   ]
-}
+}

package/src/cli/ConfigManager.js

@@ -0,0 +1,231 @@
+const path = require('path')
+const os = require('os')
+const fs = require('fs-extra')
+const { defaultConfig } = require('./configTools')
+const { logSuccess, logError, logInfo } = require('../core/utils/log')
+const { GlobalVariable } = require('../core/globalVariable')
+
+class ConfigManager {
+  config = null
+  configDir = path.join(os.homedir(), './.deepfish-ai')
+  configPath = path.join(this.configDir, './config.js')
+  constructor() {
+    this.initConfig()
+    GlobalVariable.configManager = this
+  }
+  // 初始化config
+  initConfig() {
+    fs.ensureDirSync(this.configDir)
+    // 判断之前版本的配置文件是否存在，如果存在则迁移到新目录
+    const isConfigExists = this.checkConfigExists()
+    if (
+      !isConfigExists &&
+      fs.pathExistsSync(path.join(os.homedir(), '.ai-cmd.config.js'))
+    ) {
+      fs.moveSync(path.join(os.homedir(), '.ai-cmd.config.js'), this.configPath)
+    } else if (!isConfigExists) {
+      this._writeConfig()
+    }
+    this.config = this._getConfig()
+  }
+
+  edit() {
+    const { exec } = require('child_process')
+    const platform = process.platform
+
+    let openCommand
+    if (process.env.EDITOR) {
+      openCommand = `${process.env.EDITOR} "${this.configPath}"`
+    } else if (platform === 'darwin') {
+      openCommand = `open -e "${this.configPath}"`
+    } else if (platform === 'win32') {
+      openCommand = `notepad "${this.configPath}"`
+    } else {
+      openCommand = `xdg-open "${this.configPath}"`
+    }
+    exec(openCommand, (error) => {
+      if (error) {
+        logError('Error opening configuration file:', error.message)
+      }
+    })
+  }
+
+  // 判断config是否存在
+  checkConfigExists() {
+    return fs.pathExistsSync(this.configPath)
+  }
+
+  // 重名验证
+  checkName(aiName) {
+    const existingIndex = this.config.ai.findIndex(
+      (item) => item.name === aiName,
+    )
+    return existingIndex !== -1
+  }
+
+  isAiListEmpty() {
+    return this.config.ai && this.config.ai.length === 0
+  }
+
+  // 添加一个aiConfig
+  addAiConfig(aiConfig) {
+    this.config.ai.push(aiConfig)
+    this._writeConfig(this.config)
+    logSuccess(`AI configuration "${aiConfig.name}" added successfully!`)
+  }
+
+  // 删除一个aiConfig
+  delAiConfig(aiName) {
+    const existingIndex = this.config.ai.findIndex(
+      (item) => item.name === aiName,
+    )
+    if (existingIndex === -1) {
+      logError(`Configuration with name "${aiName}" not found.`)
+      return
+    }
+    const currentAi = this.config.currentAi
+    // Check if it's the current configuration
+    if (currentAi === aiName) {
+      logError(`Cannot delete current configuration "${aiName}".`)
+      return
+    }
+    // Remove the configuration
+    this.config.ai.splice(existingIndex, 1)
+    this._writeConfig(this.config)
+    logSuccess(`AI configuration "${aiName}" deleted successfully!`)
+  }
+
+  // 设置当前Ai
+  setCurrentAi(aiName) {
+    // 查看列表中是否存在
+    const existingIndex = this.config.ai.findIndex(
+      (item) => item.name === aiName,
+    )
+    if (existingIndex === -1) {
+      logError(`Configuration with name "${aiName}" not found.`)
+      return
+    }
+    this.config.currentAi = aiName
+    this._writeConfig(this.config)
+    logSuccess(`Current AI configuration set to "${aiName}" successfully!`)
+  }
+
+  getCurrentAiConfig() {
+    return this.config.ai.find((item) => item.name === this.config.currentAi)
+  }
+
+  getCurrentAi() {
+    return this.config.currentAi
+  }
+
+  _getAiConfig(aiName) {
+    return this.config.ai.find((item) => item.name === aiName)
+  }
+
+  // 获取Ai列表
+  getAiList() {
+    console.log('AI Configurations')
+    console.log('='.repeat(50))
+    if (this.config.ai && Array.isArray(this.config.ai)) {
+      if (this.config.ai.length === 0) {
+        logError('No AI configurations found.')
+      } else {
+        this.config.ai.forEach((config, index) => {
+          const isCurrent = this.config.currentAi === config.name
+          logInfo(`${config.name} ${isCurrent ? '(current)' : ''}`)
+        })
+      }
+    } else {
+      logError('No AI configurations found.')
+    }
+    console.log('='.repeat(50))
+  }
+
+  // 重置config
+  resetConfig() {
+    console.log('Resetting configuration file:', this.configPath)
+    this._writeConfig()
+    this.config = this._getConfig()
+    logError('Configuration file has been reset to default settings.')
+  }
+
+  // 查看ai详情
+  viewAiConfigDetail(aiName) {
+    if (this.isAiListEmpty()) {
+      logError('No AI configurations found. Please add an AI configuration first.')
+      return
+    }
+    if (!aiName) {
+      aiName = this.config.currentAi
+      if (!aiName) {
+        logError('No current AI configuration set. Please input "ai config use <name>" to set a current configuration.')
+        return
+      }
+    }
+    const aiConfig = this._getAiConfig(aiName)
+    if (!aiConfig) {
+      logError('AI configuration not found. Please check the name and try again.')
+      return
+    }
+    logSuccess('AI Configuration Details')
+    logSuccess('='.repeat(50))
+    logInfo(`Name: ${aiConfig.name}`)
+    logInfo(`Type: ${aiConfig.type}`)
+    logInfo(`API Base URL: ${aiConfig.baseUrl}`)
+    logInfo(`Model: ${aiConfig.model}`)
+    if (aiConfig.apiKey) {
+      logInfo(`API Key: ${aiConfig.apiKey}`)
+    }
+    logInfo(`Temperature: ${aiConfig.temperature}`)
+    logInfo(`Max Tokens: ${aiConfig.maxTokens}`)
+    logInfo(`Streaming Output: ${aiConfig.stream ? 'Enabled' : 'Disabled'}`)
+    logInfo(
+      `Is Current: ${this.config.currentAi === aiConfig.name ? 'Yes' : 'No'}`,
+    )
+    logInfo(`File Path: ${this.configPath}`)
+    logSuccess('='.repeat(50))
+  }
+
+  // 更新扩展
+  updateExtensions(extensions) {
+    this.config.extensions = extensions
+    this._writeConfig(this.config)
+    logSuccess('Extensions updated successfully!')
+  }
+
+  // 删除扩展
+  removeExtensionByIndex(extIndex) {
+    const filePath = this.config.extensions.splice(extIndex, 1)
+    this._writeConfig(this.config)
+    logSuccess(
+      `Extension removed from config: ${filePath}.You can run 'ai ext ls' to view the changes.`,
+    )
+  }
+
+  removeExtensionByPath(filePath) {
+    this.config.extensions = this.config.extensions.filter(
+      (ext) => ext !== filePath,
+    )
+    this._writeConfig(this.config)
+    logSuccess(
+      `Extension removed from config: ${filePath}.You can run 'ai ext ls' to view the changes.`,
+    )
+  }
+
+  _getConfig() {
+    return require(this.configPath)
+  }
+
+  // 写入配置
+  _writeConfig(config) {
+    if (!config) {
+      config = defaultConfig
+    }
+    fs.writeFileSync(
+      this.configPath,
+      `module.exports = ${JSON.stringify(config, null, 2)}`,
+    )
+  }
+}
+
+module.exports = ConfigManager

package/src/cli/ExtConfigManager.js

@@ -0,0 +1,90 @@
+const path = require("path");
+const fs = require("fs-extra");
+const { GlobalVariable } = require('../core/globalVariable')
+const { logError, logSuccess } = require('../core/utils/log');
+const { traverseFiles } = require("./configTools");
+
+class ExtConfigManager {
+  constructor() {
+    this.configManager = GlobalVariable.configManager
+  }
+
+  // 添加
+  add(fileName) {
+    // 检查 fileName 是否为空
+    if (!fileName) {
+      logError('Extension file name is required.')
+      return
+    }
+    const filePath = path.resolve(process.cwd(), fileName)
+    // 判断是否路径是文件还是目录
+    if (fs.statSync(filePath).isDirectory()) {
+      // 扫描目录和子目录下所有js、cjs文件
+      const files = traverseFiles()
+      const jsFiles = files.filter(
+        (file) => file.endsWith('.js') || file.endsWith('.cjs'),
+      )
+      jsFiles.forEach((jsFile) => {
+        // 读取文件，查询文件内是否存在‘descriptions’和‘functions’
+        const fileContent = fs.readFileSync(jsFile, 'utf-8')
+        if (
+          fileContent.includes('module.exports') &&
+          fileContent.includes('descriptions') &&
+          fileContent.includes('functions')
+        ) {
+          this.add(jsFile)
+        }
+      })
+      return
+    }
+    // 判断文件是否存在
+    if (!fs.existsSync(filePath)) {
+      logError(`File not found: ${filePath}`)
+      return
+    }
+    const userConfig = this.configManager.config
+    userConfig.extensions.push(filePath)
+    // 数组去重
+    this.configManager.updateExtensions([...new Set(userConfig.extensions)])
+  }
+
+  // 删除
+  remove(fileName) {
+    const userConfig = this.configManager.config
+    // 增加对数字索引的支持
+    if (!isNaN(Number(fileName))) {
+      const extIndex = Number(fileName)
+      if (extIndex < 0 || extIndex >= userConfig.extensions.length) {
+        logError(`Invalid extension index: ${extIndex}`)
+        return
+      }
+      this.configManager.removeExtensionByIndex(extIndex)
+      return
+    }
+    const filePath = path.resolve(process.cwd(), fileName)
+    this.configManager.removeExtensionByPath(filePath)
+  }
+
+  // 查看列表
+  viewList() {
+    const extensions = this.configManager.config.extensions
+    if (extensions && Array.isArray(extensions)) {
+      console.log('='.repeat(50))
+      // 打印扩展列表，并加上索引
+      if (extensions.length === 0) {
+        console.log(`No extensions in config.`)
+      } else {
+        console.log('Extensions in config:')
+        extensions.forEach((ext, index) => {
+          console.log(`[${index}] ${ext}`)
+        })
+      }
+      console.log('='.repeat(50))
+    } else {
+      logSuccess(`No extensions in config.`)
+    }
+  }
+
+}
+
+module.exports = ExtConfigManager