🚀 Quick Start

Launch your first automated test in 5 minutes

📋 前置要求

💻 系統要求

  • Node.js 22+
    JavaScript運行時
  • Python 3.11+
    TUI應用（可選）
  • Docker
    容器化部署

🔑 API密鑰

  • Claude API密鑰
    從 https://console.anthropic.com
  • 應用URL
    要測試的應用地址
  • 認證憑證
    登入用戶名和密碼

第 1 步：安裝 AiScripto

🐳 使用 Docker（推薦）

最快的方式開始使用AiScripto：

# 拉取最新的Docker鏡像
docker pull aiscripto/aiscripto:latest

# 運行容器
docker run -it --rm \
  -e CLAUDE_API_KEY=your_api_key_here \
  -v $(pwd)/tests:/app/tests \
  -v $(pwd)/pages:/app/pages \
  aiscripto/aiscripto:latest

# 驗證安裝
docker run aiscripto/aiscripto:latest --version
# 輸出：AiScripto v2.0.0

📦 使用 npm

如果你更喜歡直接安裝：

# 使用npm安裝
npm install -g aiscripto

# 或使用yarn
yarn global add aiscripto

# 驗證安裝
aiscripto --version

第 2 步：配置環境

📝 創建 .env 文件

在你的項目目錄創建 .env 文件：

# Claude API配置
CLAUDE_API_KEY=sk-ant-xxxxxxxxxxxxx
CLAUDE_MODEL=claude-3-5-sonnet-20241022

# 應用配置
APP_URL=https://app.example.com
APP_LOGIN_URL=https://app.example.com/login
APP_USERNAME=testuser@example.com
APP_PASSWORD=your_secure_password

# Playwright配置
PLAYWRIGHT_HEADLESS=true
PLAYWRIGHT_TIMEOUT=30000

# 日誌配置
LOG_LEVEL=info
DEBUG=false

💡 安全提示

不要將 .env 文件提交到Git版本控制。 添加它到 .gitignore 並在團隊中安全共享配置。

第 3 步：編寫第一個測試用例

📝 創建測試用例文件

創建 tests/TC-001-login.txt：

@TC_ID: TC-001
@Title: 用戶登入成功流程
@Author: QA Team
@Tags: authentication, smoke

**前置條件：**
- 用戶未登入系統
- 應用可訪問

**步驟：**

Step 1: 導航至登入頁面
  Expected: 顯示用戶名和密碼欄位

Step 2: 在用戶名欄位輸入有效的電子郵件地址
  Input: testuser@example.com
  Expected: 電子郵件在欄位中顯示

Step 3: 在密碼欄位輸入密碼
  Input: SecurePassword123
  Expected: 密碼以點狀符號顯示

Step 4: 點擊「登入」按鈕
  Expected: 載入動畫出現

Step 5: 等待頁面加載完成
  Expected: 重定向到儀表板主頁
           顯示歡迎訊息「Welcome, Test User」

Step 6: 驗證用戶名在導航欄中顯示
  Expected: 右上角顯示「Test User」
自然語言 明確的期望結果 可重現的步驟

第 4 步：生成自動化測試

🚀 使用CLI命令

運行以下命令生成測試：

# 完整的轉換管道
aiscripto convert tests/TC-001-login.txt

# 或運行單個階段
aiscripto validate tests/TC-001-login.txt
aiscripto explore tests/TC-001-login.txt
aiscripto generate tests/TC-001-login.txt
aiscripto execute tests/TC-001-login.spec.ts

⏱️ 預期時間：1-3 分鐘

AiScripto將：
1️⃣ 驗證你的測試用例格式
2️⃣ 啟動瀏覽器並探索應用
3️⃣ 生成Playwright TypeScript代碼
4️⃣ 執行測試並驗證成功

第 5 步：查看生成的代碼

📂 生成的文件結構

project/
├── tests/
│   └── TC-001/
│       ├── login.spec.ts           # 生成的測試規範
│       └── login.data.json          # 測試數據（如有）
├── src/
│   └── pages/
│       └── LoginPage.ts             # 頁面物件模型
├── fixtures/
│   └── auth.ts                      # 認證fixtures
└── reports/
    └── TC-001-results.json          # 執行結果

查看生成的測試

cat tests/TC-001/login.spec.ts

你會看到完全自動生成的、型別安全的Playwright測試代碼， 遵循所有最佳實踐。

第 6 步：執行測試

▶️ 運行生成的測試

# 運行單個測試
npx playwright test tests/TC-001/login.spec.ts

# 運行所有測試
npx playwright test

# 以調試模式運行（帶GUI）
npx playwright test --debug

# 生成HTML報告
npx playwright test --reporter=html

📊 查看測試報告

# 打開HTML報告
npx playwright show-report

✨ 最佳實踐

🎯 編寫清晰的測試用例

使用清晰的語言，包括具體的步驟、輸入和預期結果。 避免歧義和複雜的邏輯。

🔒 使用測試帳戶

創建專用的測試帳戶，不要使用真實用戶數據。 定期重置測試數據以保持一致性。

📊 組織測試

按功能區域或工作流程組織測試。 使用有意義的文件名和標籤。

🔄 版本控制

提交測試用例和生成的代碼到Git。 跟蹤測試歷史和變更。

🚀 CI/CD集成

在GitHub Actions、GitLab CI或Jenkins中集成測試。 每個提交都自動運行測試。

📈 監控和優化

監控測試性能和失敗率。 定期優化慢速測試。

🔧 常見問題解決

❌ 問題：「API密鑰無效」

解決方案：

  1. 檢查 .env 文件中的 CLAUDE_API_KEY
  2. 訪問 Anthropic控制台 生成新密鑰
  3. 確保密鑰格式正確（應以 sk-ant- 開頭）
  4. 重新啟動AiScripto進程

❌ 問題：「無法連接到應用」

解決方案：

  1. 驗證 APP_URL 在 .env 中是正確的
  2. 檢查應用是否在線且可訪問
  3. 檢查防火牆和代理設置
  4. 嘗試手動導航到URL以測試連接

❌ 問題：「測試生成超時」

解決方案：

  1. 簡化測試用例（分成更小的步驟）
  2. 增加 .env 中的超時值
  3. 檢查應用的響應速度
  4. 查看日誌中的詳細錯誤信息

📚 後續步驟

1. 深入學習

查看 測試用例編寫指南 了解更多編寫技巧和最佳實踐。

2. 探索進階功能

學習數據驅動測試、自定義fixtures和参數化。 參見 架構文檔。

3. 加入社區

加入我們的 Discord社區 與其他用戶交流、 提問並分享最佳實踐。

4. 獲得幫助

需要幫助？聯絡我們的支持團隊 或查看 常見問題。

準備好開始了嗎？

現在就開始你的30天免費試用

開始免費試用 聯絡銷售