Skip to content

INSTALL.md

Latest commit

 

History

History
326 lines (233 loc) · 5.9 KB

INSTALL.md

File metadata and controls

326 lines (233 loc) · 5.9 KB

Plugin 安裝指南

🚀 推薦安裝方式

方式 1：從本地 Marketplace 安裝（最簡單）

重要：必須使用相對路徑 ./ 開頭！

步驟 1：切換到專案根目錄

cd C:\Users\alian\Desktop\github\PromptToCentext

請替換為您的實際專案路徑。

步驟 2：新增 Marketplace（使用相對路徑）

/plugin marketplace add ./src/plugins

步驟 3：安裝 Plugin

/plugin install prompt-to-context

優點：

  • ✅ 最穩定可靠
  • ✅ 支援本地開發和測試
  • ✅ 可以即時更新

等待安裝完成後，驗證安裝：

/plugin list

應該會看到 prompt-to-context 出現在列表中。

🔧 替代安裝方式

方式 2：使用互動式菜單

步驟 1：切換到專案根目錄

cd C:\Users\alian\Desktop\github\PromptToCentext

步驟 2：開啟互動式菜單

/plugin

步驟 3：新增 Marketplace

選擇「Add marketplace」，然後輸入相對路徑：

./src/plugins

步驟 4：安裝 Plugin

選擇「Browse Plugins」→ 找到 prompt-to-context → 安裝

方式 3：macOS / Linux 系統

步驟 1：切換到專案根目錄

cd /Users/YOUR_USERNAME/path/to/PromptToCentext

步驟 2：新增 Marketplace（使用相對路徑）

/plugin marketplace add ./src/plugins

步驟 3：安裝 Plugin

/plugin install prompt-to-context

✅ 驗證安裝

步驟 1：檢查 Plugin 列表

/plugin list

預期輸出：

已安裝的 Plugins:
- prompt-to-context (v1.0.0)

步驟 2：測試指令

/convert 測試問題

如果看到錯誤訊息要求 API Key，表示 Plugin 已成功安裝！

步驟 3：新增 API Key

/prompt-keys add YOUR_GEMINI_API_KEY

取得 API Key：https://makersuite.google.com/app/apikey

步驟 4：完整測試

/convert 如何學習 JavaScript？

預期輸出：

✅ 轉換成功！

【原始輸入】
如何學習 JavaScript？

【轉換結果】
我想系統性地學習 JavaScript 程式語言...

🐛 疑難排解

問題 1：找不到 Marketplace

錯誤訊息：

Marketplace "path" not found
或
No marketplaces configured.

解決方案：

  1. 必須先切換到專案根目錄

    cd C:\Users\alian\Desktop\github\PromptToCentext

  2. 使用相對路徑新增 Marketplace

    /plugin marketplace add ./src/plugins

    注意：必須使用 ./ 開頭的相對路徑！

  3. 確認目錄結構

    # 確認 marketplace.json 存在
cat C:/Users/alian/Desktop/github/PromptToCentext/src/plugins/.claude-plugin/marketplace.json

# 確認 plugin.json 存在
cat C:/Users/alian/Desktop/github/PromptToCentext/src/plugins/claude-code/.claude-plugin/plugin.json

    應該看到：

    plugins/
├── .claude-plugin/
│   └── marketplace.json     ← Marketplace 配置
└── claude-code/
    ├── .claude-plugin/
    │   └── plugin.json      ← Plugin 配置
    ├── commands/
    └── ...

  4. 路徑格式說明

    • ✅ 正確：./src/plugins（在專案根目錄時）
    • ❌ 錯誤：C:/Users/.../src/plugins（絕對路徑不支援）
    • ❌ 錯誤：../plugins（上層目錄路徑）
    • ❌ 錯誤：直接指向 plugin 目錄（應該指向 marketplace 目錄）

  5. 驗證 Marketplace

    /plugin marketplace list

問題 2：安裝後找不到指令

錯誤訊息：

Unknown command: /convert

解決方案：

  1. 重啟 Claude Code

    • 關閉所有 Claude Code 視窗
    • 重新開啟

  2. 檢查 Plugin 狀態

    /plugin list

  3. 重新安裝

    /plugin uninstall prompt-to-context
/plugin install prompt-to-context

問題 3：API Key 錯誤

錯誤訊息：

請先新增 API Key

解決方案：

  1. 新增 API Key

    /prompt-keys add AIzaSy...

  2. 驗證格式

  3. 檢查 Key 列表

    /prompt-keys list

問題 4：轉換失敗

錯誤訊息：

轉換失敗：...

可能原因和解決方案：

  1. 網路問題

    • 檢查網路連線
    • 確認可以訪問 Google API

  2. API 配額用完

    /prompt-keys add ANOTHER_API_KEY

  3. API Key 無效

    /prompt-keys remove 1
/prompt-keys add NEW_API_KEY

  4. 輸入過長

    • 減少輸入文字長度（限制 10,000 字元）

📋 完整安裝檢查清單

安裝前檢查：

  • 已安裝 Claude Code（版本 >= 1.0.0）
  • 有穩定的網路連線
  • 已取得 Gemini API Key

安裝步驟：

  • 執行安裝指令
  • 等待安裝完成
  • 重啟 Claude Code
  • 執行 /plugin list 驗證
  • 新增 API Key
  • 執行測試轉換

安裝成功標準：

  • /plugin list 顯示 prompt-to-context
  • /convert 測試 可以執行（即使缺 API Key 也會有提示）
  • /prompt-keys list 可以顯示 Keys
  • 完整測試轉換成功

🆘 需要協助？

如果以上方法都無法解決問題：

  1. 查看日誌

    # 檢查 Plugin 目錄的日誌
cat C:\Users\alian\Desktop\github\PromptToCentext\src\plugins\claude-code\logs\plugin.log

  2. 提交 Issue https://github.com/alianrektdoug/PromptToCentext/issues

    請提供：

    • Claude Code 版本
    • 作業系統
    • 完整錯誤訊息
    • 安裝指令

  3. 參考文件

最後更新: 2025-10-16 版本: 1.0.0