luxray-agent 0.0.0-stage → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +76 -2
- package/dist/bin/luxray-agent.d.ts +1 -0
- package/dist/bin/luxray-agent.js +9345 -0
- package/dist/bin/luxray-agent.js.map +1 -0
- package/dist/client/agent-client.d.ts +93 -0
- package/dist/client/agent-client.js +326 -0
- package/dist/client/agent-client.js.map +1 -0
- package/dist/client/luxray-api-client.d.ts +63 -0
- package/dist/client/luxray-api-client.js +69 -0
- package/dist/client/luxray-api-client.js.map +1 -0
- package/dist/client/task-stream.d.ts +88 -0
- package/dist/client/task-stream.js +478 -0
- package/dist/client/task-stream.js.map +1 -0
- package/dist/execution/exploration-job.d.ts +90 -0
- package/dist/execution/exploration-job.js +5625 -0
- package/dist/execution/exploration-job.js.map +1 -0
- package/dist/execution/openapi-spec.d.ts +59 -0
- package/dist/execution/openapi-spec.js +4694 -0
- package/dist/execution/openapi-spec.js.map +1 -0
- package/dist/execution/task-executor.d.ts +160 -0
- package/dist/execution/task-executor.js +577 -0
- package/dist/execution/task-executor.js.map +1 -0
- package/dist/execution/test-job.d.ts +34 -0
- package/dist/execution/test-job.js +42 -0
- package/dist/execution/test-job.js.map +1 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.js +1018 -0
- package/dist/index.js.map +1 -0
- package/dist/vault/credential-vault.d.ts +30 -0
- package/dist/vault/credential-vault.js +116 -0
- package/dist/vault/credential-vault.js.map +1 -0
- package/package.json +50 -4
package/README.md
CHANGED
|
@@ -1,3 +1,77 @@
|
|
|
1
|
-
#
|
|
1
|
+
# luxray-agent
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Official local execution agent CLI for **[Luxray](https://github.com/luxray)** — Autonomous API Intelligence & Reverse Engineering.
|
|
4
|
+
|
|
5
|
+
`luxray-agent` connects your local machine to the Luxray control plane, enabling headless browser crawling, network traffic interception, automated schema discovery, and deterministic OpenAPI 3.1 generation.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
### Run directly with `npx` (No installation needed)
|
|
12
|
+
```bash
|
|
13
|
+
npx luxray-agent --help
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
### Install globally via `npm`
|
|
17
|
+
```bash
|
|
18
|
+
npm install -g luxray-agent
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Quick Start
|
|
24
|
+
|
|
25
|
+
### 1. Register Your Agent
|
|
26
|
+
|
|
27
|
+
#### Interactive Web Login (Recommended)
|
|
28
|
+
Register directly using your Luxray web account credentials:
|
|
29
|
+
```bash
|
|
30
|
+
luxray-agent register
|
|
31
|
+
```
|
|
32
|
+
This prompts for your email and password, provisions an Agent API Key, and securely stores it in your machine's local credential vault (`~/.luxray/agent.json`).
|
|
33
|
+
|
|
34
|
+
#### Manual Registration with API Key
|
|
35
|
+
If you generated an Agent Key from the Luxray Web Dashboard:
|
|
36
|
+
```bash
|
|
37
|
+
luxray-agent register --api-key <YOUR_AGENT_API_KEY>
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
### 2. Connect & Listen for Tasks
|
|
43
|
+
|
|
44
|
+
Once registered, start the agent daemon to connect to the Luxray platform:
|
|
45
|
+
```bash
|
|
46
|
+
luxray-agent start
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
The agent maintains a resilient connection, streams heartbeats, receives exploration and testing tasks, and dispatches outcomes back to the control plane.
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
### 3. CLI Commands
|
|
54
|
+
|
|
55
|
+
| Command | Description |
|
|
56
|
+
|---|---|
|
|
57
|
+
| `luxray-agent register` | Register the machine with the Luxray platform and store credentials |
|
|
58
|
+
| `luxray-agent start` | Start the execution daemon and listen for dispatched tasks |
|
|
59
|
+
| `luxray-agent explore <url>` | Run an ad-hoc local exploration and OpenAPI generation job |
|
|
60
|
+
| `luxray-agent status` | Check registration status and local vault credentials |
|
|
61
|
+
| `luxray-agent logout` | Revoke and purge local agent credentials |
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## Prerequisites
|
|
66
|
+
|
|
67
|
+
- **Node.js**: `v20.0.0` or higher
|
|
68
|
+
- **Chromium / Playwright**: For automated browser exploration, install browser binaries when prompted:
|
|
69
|
+
```bash
|
|
70
|
+
npx playwright install chromium
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## License
|
|
76
|
+
|
|
77
|
+
MIT
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
#!/usr/bin/env node
|