LuawardDocs

SDK и CLI

Установка официальных пакетов @luaward/sdk, luaward (Python) и @luaward/cli из npm и PyPI, а также различия токенов.

Проверяйте официальные названия пакетов перед установкой

Устанавливайте пакеты только по официальным ссылкам ниже и через github.com/luaward. Следите за типом токена: SDK используют Developer API key воркспейса (lwa_live_...), а CLI требует Personal token (lwm_...).

Официальные пакеты

ИнструментРеестр и пакетАутентификацияТребования
JS / TS SDKnpm @luaward/sdkDeveloper API key (lwa_live_...)Node.js / стандартный fetch
Python SDKPyPI luawardDeveloper API key (lwa_live_...)Python 3.10+, без внешних зависимостей
Luaward CLInpm @luaward/cliPersonal token (lwm_...)Node.js 20+
Официальный GitHubgithub.com/luawardРепозитории и документацияОфициальная организация

JavaScript / TypeScript SDK (@luaward/sdk)

Установка из npm:

npm install @luaward/sdk

Инициализируйте LuawardClient на сервере с помощью Developer API key (lwa_live_...) и 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",
});
  • Базовый URL: По умолчанию https://api.luaward.com (префикс /v3 добавляется автоматически).
  • Доступные модули: projects, keys, scripts, stats, универсальный lw.request() и LuarmorCompat (сверяйте поля перед миграцией).
  • Повторы и ошибки: Повторяет HTTP 429 и 503 до 3 раз с учётом Retry-After и выбрасывает типизированные ошибки (LuawardAuthError, LuawardRateLimitError, LuawardPlanLimitError, LuawardNotFoundError, LuawardError).

Подробности по scope и эндпоинтам см. в Обзоре Developer API и Справочнике API v3.

Python SDK (luaward)

Установка из PyPI:

pip install luaward

Используйте LuawardClient в синхронных скриптах или 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"])
  • Без внешних зависимостей: Использует стандартный модуль urllib и требует Python 3.10+. AsyncLuawardClient выполняет запросы через asyncio.to_thread().
  • Функциональность: Синхронный клиент содержит keys, scripts, stats и request(), асинхронный предоставляет keys и request(). Также включены LuarmorCompat и AsyncLuarmorCompat.
  • Повторы и исключения: Повторяет HTTP 429 и 503 до 3 раз; типизированные исключения находятся в luaward.exceptions.

Luaward CLI (@luaward/cli)

Глобальная установка из 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 (ключ lwa_live_... не подойдёт). Сейчас панель управления и IDE API находятся в режиме Early Access.
  • Хранение токена: В ~/.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, ИИ и MCP

  • Расширение для VS Code / Cursor: Пока не опубликовано в VS Code Marketplace и Open VSX. Обратитесь в поддержку, чтобы получить проверенный .vsix на этапе Early Access.
  • ИИ и MCP: Подключайте Claude, ChatGPT, Claude Code или Cursor к своим игровым сессиям и скриптам через Workspace MCP.