Superjolt

🚀 Superjolt CLI (Beta)

🤖 Superjolt CLI是一款支持MCP的AI驅動部署平臺的官方命令行工具，可藉助AI輔助輕鬆部署和管理JavaScript應用程序，為開發者提供高效、便捷的雲端部署體驗。

⚡ 重要提示

目前Superjolt處於Beta版本，我們正在根據您的反饋積極改進。歡迎加入我們的 Discord 分享您的使用體驗！在Beta階段，CLI將自動檢查關鍵更新，以確保與我們不斷發展的API兼容。

🚀 快速開始

在您的JavaScript框架項目文件夾中，運行以下命令：

npx superjolt deploy

就是這麼簡單！CLI將引導您完成身份驗證和部署過程。

✨ 主要特性

• 🚀 一鍵部署：使用 npx superjolt deploy 即可完成部署。
• 🤖 通過MCP實現AI驅動的基礎設施管理。
• 🔧 全面的服務生命週期管理。
• 🔐 安全的環境變量處理。
• 📊 即時日誌和監控。
• 🌐 自動SSL和自定義域名支持。

📦 安裝指南

您可以通過以下幾種方式安裝Superjolt CLI：

使用npx（無需安裝）

npx superjolt deploy

全局安裝

使用npm全局安裝Superjolt CLI：

npm install -g superjolt

或者使用yarn：

yarn global add superjolt

💻 使用示例

部署Node.js應用程序

# 進入項目目錄
cd my-node-app

# 登錄Superjolt
superjolt login

# 部署應用
superjolt deploy

# 部署並顯示詳細構建輸出
superjolt deploy --verbose

管理環境變量

# 設置單個變量
superjolt env:set NODE_ENV production

# 推送整個.env文件
superjolt env:push

# 列出所有變量
superjolt env:list

管理自定義域名

# 添加自定義域名（使用.superjolt文件中的服務ID）
superjolt domain:add app.example.com

# 添加到特定服務
superjolt domain:add app.example.com happy-blue-fox

# 添加為主域名
superjolt domain:add www.example.com --primary

# 列出所有域名
superjolt domain:list

# 檢查域名狀態
superjolt domain:status app.example.com

# 刪除域名
superjolt domain:remove app.example.com

管理機器

# 創建新機器
superjolt machine:create

# 列出所有機器
superjolt machine:list

# 設置默認機器
superjolt machine:use happy-blue-fox

使用Claude進行AI驅動的管理

MCP配置完成後，您可以使用自然語言進行操作：

您："顯示所有正在運行的服務"
Claude：[列出所有服務及其狀態]

您："重啟API服務並查看其日誌"
Claude：[重啟服務並顯示最近的日誌]

您："為我的數據庫連接設置環境變量"
Claude：[幫助配置DATABASE_URL和相關變量]

📚 詳細文檔

命令說明

身份驗證

• superjolt login - 使用您的Superjolt賬戶進行身份驗證。
• superjolt logout - 從您的賬戶註銷。
• superjolt me - 顯示當前用戶信息。
• superjolt token - 顯示用於CI/CD的身份驗證令牌。
  • --show - 顯示完整令牌（用於導出）。

部署

• superjolt deploy [options] - 將您的應用程序部署到Superjolt。
  • -p, --path <path> - 應用程序目錄的路徑（默認為當前目錄）。
  • -s, --service <serviceId> - 部署到現有服務（可選）。
  • -m, --machine <machineId> - 要部署到的機器ID。
  • -n, --name <name> - 服務名稱（新服務默認為package.json中的名稱）。
  • -v, --verbose - 顯示詳細的構建輸出和日誌。

機器管理

• superjolt machine:create - 創建新機器。
• superjolt machine:list - 列出所有機器。
• superjolt machine:delete <machine-id> - 刪除機器。
• superjolt machine:use <machine-id> - 設置部署的默認機器。
• superjolt machine:rename [machine-id] <new-name> - 重命名機器（如果省略ID，則使用默認機器）。

服務管理

• superjolt service:list [machine-id] - 列出機器的服務。
• superjolt service:start <service-id> - 啟動服務。
• superjolt service:stop <service-id> - 停止服務。
• superjolt service:restart <service-id> - 重啟服務。
• superjolt service:rename <service-id> <new-name> - 重命名服務（別名：rename）。
• superjolt service:delete <service-id> - 刪除服務。

自定義域名

• superjolt domain:add <domain> [service-id] - 為服務添加自定義域名（如果省略服務ID，則使用.superjolt文件）。
  • -p, --primary - 設置為服務的主域名。
• superjolt domain:list [service-id] - 列出自定義域名（別名：domains）。
• superjolt domain:status <domain> - 檢查域名驗證狀態。
• superjolt domain:remove <domain> - 刪除自定義域名（別名：domain:delete）。

環境變量

• superjolt env:list - 列出環境變量。
• superjolt env:set <key> <value> - 設置環境變量。
• superjolt env:get <key> - 獲取環境變量。
• superjolt env:unset <key> - 刪除環境變量。
• superjolt env:push - 將.env文件推送到您的應用程序。

日誌

• superjolt logs [service-id] - 查看應用程序的即時日誌。

其他命令

• superjolt reset - 刪除所有機器和服務（破壞性操作 - 需要確認）。
• superjolt update - 將CLI更新到最新版本。
• superjolt update --check - 檢查更新但不安裝。
• superjolt status - 顯示CLI配置、版本和存儲的數據（別名：info, config）。
  • --show-token - 顯示完整的身份驗證令牌。

配置說明

項目配置

首次部署後，CLI會在項目根目錄自動創建一個 .superjolt 文件，該文件用於跟蹤以下信息：

{
  "serviceId": "clever-red-deer"
}

這允許CLI確定是更新現有部署還是創建新部署。

部署忽略文件（.superjoltignore）

您可以在項目根目錄創建一個 .superjoltignore 文件，以排除特定文件和目錄的部署。該文件遵循與 .gitignore 相同的語法。

# 忽略測試文件
**/*.test.js
**/*.spec.js
__tests__/

# 忽略開發文件
*.dev.js
.vscode/
.idea/

# 忽略特定目錄
docs/
examples/

# 開發期間忽略大資產
videos/
*.mp4

CI/CD集成

Superjolt CLI支持通過環境變量進行身份驗證，以實現無縫的CI/CD集成。

設置CI/CD身份驗證

1. 獲取身份驗證令牌：

superjolt token --show

2. 將令牌設置為CI/CD平臺中的機密：

• GitHub Actions：添加為名為 SUPERJOLT_TOKEN 的存儲庫機密。
• GitLab CI：添加為受保護的CI/CD變量。
• CircleCI：在項目設置中添加為環境變量。
• 其他平臺：將 SUPERJOLT_TOKEN 設置為安全的環境變量。

3. 在CI/CD管道中使用：

GitHub Actions示例

name: Deploy to Superjolt

on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      
      - name: Setup Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'
          
      - name: Install dependencies
        run: npm ci
        
      - name: Deploy to Superjolt
        env:
          SUPERJOLT_TOKEN: ${{ secrets.SUPERJOLT_TOKEN }}
        run: npx superjolt deploy

GitLab CI示例

deploy:
  stage: deploy
  image: node:18
  script:
    - npm ci
    - npx superjolt deploy
  only:
    - main
  variables:
    SUPERJOLT_TOKEN: $SUPERJOLT_TOKEN

通用腳本示例

#!/bin/bash
export SUPERJOLT_TOKEN="your-token-here"
npx superjolt deploy

安全最佳實踐

• 切勿將令牌提交到版本控制
• 將令牌存儲為CI/CD平臺中的加密機密。
• 為不同環境（暫存、生產）使用不同的令牌。
• 定期輪換令牌。
• 令牌可提供對您的Superjolt賬戶的完全訪問權限 - 請謹慎處理。

環境變量身份驗證

當設置了 SUPERJOLT_TOKEN 時，CLI將：

• 跳過基於瀏覽器的登錄流程。
• 使用令牌進行所有API請求。
• 在無頭環境（CI/CD、容器）中工作。 您可以使用以下命令驗證令牌來源：

superjolt status

🔧 技術細節

Superjolt CLI是首個原生支持Model Context Protocol (MCP) 的部署平臺之一，允許您通過Claude Desktop等AI助手管理整個基礎設施。

為什麼選擇MCP？

• 自然語言控制：使用對話式命令管理部署。
• 上下文感知操作：AI瞭解您的基礎設施狀態。
• 自動化工作流程：讓AI處理複雜的部署序列。
• 錯誤解決：獲得智能幫助以解決部署問題。

設置MCP

1. 安裝Superjolt CLI（包括MCP服務器）：

npm install -g superjolt

2. 使用Superjolt進行身份驗證：

superjolt login

3. 添加到Claude Desktop配置：

• macOS：~/Library/Application Support/Claude/claude_desktop_config.json
• Windows：%APPDATA%\Claude\claude_desktop_config.json
• Linux：~/.config/claude/claude_desktop_config.json

{
  "mcpServers": {
    "superjolt": {
      "command": "superjolt-mcp",
      "args": []
    }
  }
}

4. 重啟Claude Desktop

MCP功能

配置完成後，您可以使用自然語言進行以下操作：

身份驗證和CI/CD設置

• "獲取我用於CI/CD的身份驗證令牌"
• "展示如何設置GitHub Actions"
• "檢查我是否已通過身份驗證"

基礎設施管理

• "創建新的生產機器"
• "列出所有正在運行的服務"
• "展示已停止的服務"
• "刪除所有測試機器"

部署操作

• "重啟我的API服務"
• "停止暫存環境"
• "查看Web服務的日誌"

配置

• "為我的後端設置DATABASE_URL"
• "列出所有環境變量"
• "更新生產環境的API密鑰"

自定義域名

• "將app.example.com添加到我的Web服務"
• "列出所有自定義域名"
• "檢查我的域名驗證狀態"
• "刪除old.example.com"

可用的MCP工具

📄 許可證

本項目採用MIT許可證，詳情請參閱 LICENSE 文件。

其他信息

Web 儀表盤

您可以通過我們的Web界面 users.superjolt.com 管理您的部署：

• 📊 查看部署指標和使用情況。
• 🔧 管理服務和環境變量。
• 📱 即時監控您的應用程序。
• 🚀 訪問部署日誌和歷史記錄。

支持

• 儀表盤：https://users.superjolt.com
• 文檔：https://superjolt.com/docs
• 問題反饋：https://github.com/scoritz/superjolt/issues
• Discord：https://superjolt.com/discord
• 郵箱：support@superjolt.com

貢獻

我們歡迎您的貢獻！請參閱 貢獻指南 瞭解詳細信息。