LuawardDocs

SDK และ CLI

ติดตั้งแพ็กเกจทางการ @luaward/sdk, luaward (Python) และ @luaward/cli จาก npm และ PyPI พร้อมวิธีแยกประเภท token

ตรวจสอบชื่อแพ็กเกจทางการก่อนติดตั้ง

ติดตั้งเฉพาะแพ็กเกจจากลิงก์ทางการด้านล่างและ github.com/luaward เท่านั้น พร้อมเลือกใช้ credential ให้ตรงประเภท: SDK ใช้ Developer API key (lwa_live_...) ของ workspace ส่วน CLI ใช้ Personal token (lwm_...)

แพ็กเกจทางการทั้งหมด

เครื่องมือRegistry และแพ็กเกจการยืนยันตัวตนความต้องการระบบ
JavaScript / TypeScript SDKnpm @luaward/sdkDeveloper API key (lwa_live_...)Node.js / fetch มาตรฐาน
Python SDKPyPI luawardDeveloper API key (lwa_live_...)Python 3.10+, ไม่มี dependency ภายนอก
Luaward CLInpm @luaward/cliPersonal token (lwm_...)Node.js 20+
GitHub องค์กรทางการgithub.com/luawardหน้าโปรไฟล์และลิงก์เอกสารOfficial organization

JavaScript / TypeScript SDK (@luaward/sdk)

ติดตั้งจาก npm:

npm install @luaward/sdk

สร้าง LuawardClient บนฝั่งเซิร์ฟเวอร์ด้วย Developer API key (lwa_live_...) และ project ID ของคุณ:

import { LuawardClient } from "@luaward/sdk";

const lw = new LuawardClient({
  apiKey: process.env.LUAWARD_API_KEY,
  projectId: process.env.LUAWARD_PROJECT_ID,
});

const created = await lw.keys.create({
  discord_id: "123456789012345678",
  key_days: 30,
  note: "Monthly access",
});

const queued = await lw.scripts.upload(process.env.LUAWARD_SCRIPT_ID, {
  source: 'print("Hello from SDK")',
  preset: "balanced",
});
  • Base URL: ค่าเริ่มต้นคือ https://api.luaward.com โดย SDK เติม /v3 ให้อัตโนมัติ
  • โมดูลที่มีให้: projects, keys, scripts, stats, lw.request() และ LuarmorCompat (ควรเทียบ schema ก่อนย้ายระบบ)
  • Auto-retry และ error classes: retry HTTP 429 และ 503 อัตโนมัติสูงสุด 3 ครั้งโดยอ่าน Retry-After และแยก error ชัดเจน (LuawardAuthError, LuawardRateLimitError, LuawardPlanLimitError, LuawardNotFoundError, LuawardError)

ดูรายละเอียด scope และ endpoint ทั้งหมดได้ที่ ภาพรวม Developer API และ เอกสารอ้างอิง API v3

Python SDK (luaward)

ติดตั้งจาก PyPI:

pip install luaward

ใช้งานได้ทั้งแบบ sync (LuawardClient) และ async (AsyncLuawardClient):

import os
from luaward import LuawardClient

lw = LuawardClient(
    api_key=os.environ["LUAWARD_API_KEY"],
    project_id=os.environ["LUAWARD_PROJECT_ID"],
)

created = lw.keys.create(
    discord_id="123456789012345678",
    key_days=30,
    note="Monthly access",
)
print(created["user_key"])
  • ไม่มี dependency ภายนอก: ใช้ urllib มาตรฐานของ Python (รองรับ Python 3.10+), ส่วน AsyncLuawardClient รันผ่าน asyncio.to_thread()
  • ความครอบคลุม: sync client มี keys, scripts, stats, และ request(), ส่วน async client มี keys และ request() พร้อม LuarmorCompat / AsyncLuarmorCompat
  • Auto-retry และ exceptions: retry HTTP 429 / 503 สูงสุด 3 ครั้ง และโยน typed exceptions จาก luaward.exceptions

Luaward CLI (@luaward/cli)

ติดตั้งแบบ global จาก npm (ต้องใช้ Node.js 20 ขึ้นไป):

npm install -g @luaward/cli
luaward --version

หรือติดตั้งจากไฟล์ tarball ทางการบน luaward.com:

npm install -g https://luaward.com/luaward-cli.tgz
luaward --version
  • การยืนยันตัวตนและ Early Access: ใช้ Personal token (lwm_...) เชื่อมต่อกับ https://luaward.com/api/ide (ใช้แทน Developer API key lwa_live_... ไม่ได้) ปัจจุบันแดชบอร์ดและ IDE API ยังเปิดแบบ Early Access
  • ที่เก็บ credentials: บันทึกไว้ที่ ~/.config/luaward/credentials.json (เปลี่ยนได้ด้วย LUAWARD_CONFIG_DIR) หรือส่งผ่านตัวแปร LUAWARD_TOKEN
  • คำสั่งหลัก: login, init, scripts, pull, push, toggle, sessions, pair, dev, exec, stop, keys, errors รองรับ --json / -j สำหรับ CI

IDE, AI และ MCP

  • VS Code / Cursor Extension: ยังไม่ได้เผยแพร่บน VS Code Marketplace หรือ Open VSX สามารถติดต่อทีมช่วยเหลือ เพื่อขอไฟล์ .vsix ที่ทดสอบแล้วในช่วง Early Access
  • AI และ MCP: เชื่อมต่อ Claude, ChatGPT, Claude Code หรือ Cursor เข้ากับเซสชันทดสอบและสคริปต์ของคุณได้ที่หน้า AI และ MCP