Orvex API Reference

https://www.orvex-sc.xyz

npm install -g @orvex/cli

[System.Environment]::SetEnvironmentVariable(
  "PATH",
  [System.Environment]::GetEnvironmentVariable("PATH","User") + ";$env:APPDATA\npm",
  "User"
)

npm install -g @orvex/cli

# Find the npm global prefix (works with all npm versions)
npm config get prefix

# The binaries are at <prefix>/bin — add it to your shell (bash example)
echo 'export PATH="$(npm config get prefix)/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

# Verify
orvex

# Run without arguments to see the startup animation (first time only)
orvex

# Then authenticate:
orvex login

# Protect a script:
orvex obfuscate

# View connected devices:
orvex sessions

npm install @orvex/sdk

import { OrvexClient } from "@orvex/sdk"

const client = new OrvexClient({ apiKey: process.env.ORVEX_API_KEY })

const { output } = await client.obfuscate({
  code: `
    local function hello()
      print("Hello, World!")
    end
    hello()
  `,
  luaVersion: "fivem",
})

// output contains the protected Lua bytecode
console.log(output)

curl https://www.orvex-sc.xyz/api/obfuscate \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"code": "print(\"hello\")", "luaVersion": "fivem"}'

{
  "ok": true,
  "output": "-- [OrvexSecurity | Lua 5.1]\nlocal _unpack=unpack..."
}

{
  "error": "[L14:Parser] expected 'end', got ':' at 12:5"
}

{
  "results": [
    { "path": "server/main.lua",   "ok": true,  "output": "..." },
    { "path": "server/config.lua", "ok": false, "error": "[L14:Lexer] unexpected character..." }
  ]
}

curl https://www.orvex-sc.xyz/api/obfuscate/batch \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "luaVersion": "fivem",
    "files": [
      { "path": "server/main.lua",   "code": "print(\"main\")" },
      { "path": "server/config.lua", "code": "print(\"cfg\")"  }
    ]
  }'

curl "https://www.orvex-sc.xyz/api/history?offset=0&limit=50" \
  -H "Authorization: Bearer your_api_key"

{
  "history": [
    {
      "id": "abc123",
      "filename": "main.lua",
      "size": 4096,
      "plan": "pro",
      "status": "success",
      "createdAt": "2026-06-24T14:32:00Z"
    }
  ],
  "total": 142,
  "offset": 0,
  "limit": 50,
  "retentionDays": 90
}

X-RateLimit-Limit: 120        # your plan's per-minute budget
X-RateLimit-Remaining: 117    # units left in the current window
X-RateLimit-Reset: 1750792080 # unix time when the window resets

# On 429, additionally:
Retry-After: 12               # seconds to wait before retrying

-- Original source
for i = 1, 10 do
  print(i)
end

-- After OrvexSecurity (VM L14 bytecode, simplified representation)
-- The actual output is unreadable bytecode, not Lua source.
-- This is an illustration of the transformation applied internally.
local _state = 7
while _state ~= 40 do
  if _state == 7 then _state = 12
  elseif _state == 12 then
    -- loop body, encoded as opcode stream
    _state = 40
  end
end

const { output } = await client.obfuscate({
  code: myScript,
  luaVersion: "fivem",
  options: {
    controlFlow: true,
    deadCode:    true,
    vmInjection: true,   // Pro+
    multiLayer:  true,   // Premium+
  },
})

npm install @orvex/sdk

import { OrvexClient, OrvexQuotaError, OrvexParseError } from "@orvex/sdk"

const client = new OrvexClient({
  apiKey:  process.env.ORVEX_API_KEY!,
  timeout: 30_000,
})

try {
  // Single file
  const { output } = await client.obfuscate({
    code:       luaSource,
    luaVersion: "fivem",
    options: { vmInjection: true },
  })
  await fs.writeFile("dist/main.lua", output)

  // Batch (Pro+)
  const { results } = await client.obfuscateBatch({
    files: [
      { path: "server/main.lua",   code: await fs.readFile("server/main.lua",   "utf8") },
      { path: "server/config.lua", code: await fs.readFile("server/config.lua", "utf8") },
    ],
    luaVersion: "fivem",
  })
  for (const r of results) {
    if (r.ok) await fs.writeFile(`dist/${r.path}`, r.output!)
    else console.error(r.path, r.error)
  }
} catch (err) {
  if (err instanceof OrvexQuotaError)  console.error("Quota exceeded")
  else if (err instanceof OrvexParseError) console.error("Syntax error at", err.location)
  else throw err
}

# .github/workflows/protect.yml
name: Protect Lua scripts

on:
  push:
    branches: [main]

jobs:
  protect:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: 20

      - run: npm install @orvex/sdk

      - run: node scripts/protect.mjs
        env:
          ORVEX_API_KEY: ${{ secrets.ORVEX_API_KEY }}

// scripts/protect.mjs
import { OrvexClient } from "@orvex/sdk"
import { readFile, writeFile, mkdir } from "fs/promises"
import { glob } from "glob"

const client = new OrvexClient({ apiKey: process.env.ORVEX_API_KEY })

const files = await glob("server/**/*.lua")
await mkdir("dist/server", { recursive: true })

const { results } = await client.obfuscateBatch({
  files: await Promise.all(
    files.map(async path => ({ path, code: await readFile(path, "utf8") }))
  ),
  luaVersion: "fivem",
})

let failed = 0
for (const r of results) {
  if (r.ok) {
    await writeFile(`dist/${r.path}`, r.output)
    console.log("✓", r.path)
  } else {
    console.error("✗", r.path, r.error)
    failed++
  }
}

if (failed > 0) process.exit(1)