Skip to content

HimService/Simple-CLI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Simple CLI Icon

🚀 Simple CLI (AI代理CLI)


Simple CLI 是一個基於 TypeScript 構建的高級 AI 代理程式平台。它不僅僅是一個對話工具,更是一個具備「動作實施能力」的終端機助手。透過強大的工具連接器 (Tool Calling) 與動態插件系統,您可以讓 AI 直接操作您的檔案系統、執行系統指令,並透過自定義插件無限擴充其能力。


✨ 核心特性

  • 🤖 Agentic 自動化循環:具備自主思考與工具調用能力,能連續執行多個任務直到達成目標。
  • 🔌 動態插件系統:無需修改核心代碼,只需放置 .js 檔案即可讓 AI 學會新技能。
  • 🛡️ 進階安全模型:支援「手動確認」與「自動執行 (Autonomous)」雙模式,並具備嚴格的權限過濾。
  • 🎨 極致終端機美學:實時 Markdown 渲染、流式輸出緩衝補償、動態狀態指示器 (Ora Spinners)。
  • ⚙️ 多模型驅動:原生支援 OpenAI, Google Gemini 以及 本地端模型 (LM Studio/Ollama)。

🛠️ 開發者指南:如何編寫擴充工具 (Plugins)

本專案最強大的地方在於其 「零干預插件系統」。AI 的所有能力本質上都是一個「工具 (Tool)」,您可以透過在 plugins/ 目錄新增腳本來擴展它。

你可以在此查看文檔

📦 安裝與快速啟動

📋 系統環境要求

  • Node.js: v18.0.0 或更高版本 (建議使用最新的 LTS 版本)。
  • npm: 隨 Node.js 安裝的套件管理器。
  • TypeScript: 專案核心語言,執行前需經過編譯。

⚙️ 核心依賴項概覽

安裝時,系統會自動下載以下關鍵套件:

  • AI SDK: @google/generative-ai & openai (支援多模型對話)。
  • 互動介面: inquirer (問答選單) & ora (動態載入動畫)。
  • 文字渲染: chalk (顏色標註) & marked-terminal (Markdown 終端渲染)。
  • 底層工具: commander (CLI 命令解析) & conf (跨平台設定持久化)。
  • 開發工具: typescript & ts-node (開發期直接執行 TS)。

🚀 逐步安裝指南

  1. 安裝所有依賴: 在專案根目錄執行以下指令,這將確保所有 AI 模型 SDK 與 CLI 工具正確安裝。

    npm install
  2. 編譯專案: 將 TypeScript 代碼轉換為 Node.js 可執行的 JavaScript。

    npm run build
  3. 啟動專案: 在專案目錄下執行指令。

    node dist/index.js

4. 初始化配置

設定您的 API Key (如 OpenAI 或 Gemini) 與預設模型。

  • 路徑: 首頁模型與 API 配置模型提供商與 API 設定

5. 設置全域指令 (強烈建議)

執行指令將 spc 連結到系統路徑,讓您在 任何資料夾 下皆可啟動。

  • 路徑: 首頁模型與 API 配置全域啟動指令 (spc)

6. 開始對話

一切就緒,立即進入互動模式。

  • 路徑: 首頁開始互動式對話/快速提問

✅ 驗證安裝

您可以執行以下指令確認安裝是否成功(你需要先設置全域指令!!!):

spc --version

若輸出目前版本號,即代表安裝成功!


🛡️ 安全性配置

為了保護您的電腦安全,我們設計了分層權限:

  • 手動模式 [預設]: 當 AI 嘗試執行 runCommand (系統指令) 時,會跳出詢問框,獲得您的 (y/N) 授權後才執行。
  • 自動模式 (Autonomous): 適合信任模型且需要高度自動化的場景。可在 設定 > 安全性 中開啟,開啟後 AI 將不再詢問,直接執行指令。

Warning

開啟自動模式具備極高風險。 建議僅在受控環境或處理可信任任務時開啟。


📁 專案目錄結構

.
├── plugins/           # 🔌 外部插件存放區 (JS 格式)
├── src/
│   ├── config/        # ⚙️ 設定檔管理與持久化 (Conf)
│   ├── core/          # 🧠 Agent 核心循環與對話歷史管理
│   ├── providers/     # 🤖 模型提供商實作 (OpenAI, Gemini, etc.)
│   ├── tools/         # 🛠️ 內建核心工具模組 (讀、寫、列表、指令)
│   └── index.ts       # 🚀 CLI 入口點與 UI 渲染邏輯
├── dist/              # 📦 編譯後的代碼輸出
└── package.json

📄 授權協議

請閱 License.txt

About

Simple-CLI 是一個為 AI 模型設計的代理人(Agent)控制台,能幫助你輕鬆開發或修復你的專案。 || Simple-CLI is a agent console for AI Model that helps you develop or fix your projects easily.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors