@auxot/worker-cli 0.1.6 → 0.3.3

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 CHANGED
@@ -11,29 +11,28 @@ Connect your local GPU resources to the Auxot platform. The worker CLI automatic
11
11
  ## Installation
12
12
 
13
13
  ```bash
14
- # From npm (once published)
15
- npm install -g @auxot/worker-cli
14
+ # Run directly with npx (recommended)
15
+ npx @auxot/worker-cli --gpu-key YOUR_GPU_KEY
16
16
 
17
- # Or run directly from source
18
- cd apps/worker-cli
19
- pnpm install
20
- pnpm run dev -- --gpu-key YOUR_KEY
17
+ # Or install globally
18
+ npm install -g @auxot/worker-cli
19
+ auxot-worker-cli --gpu-key YOUR_GPU_KEY
21
20
  ```
22
21
 
23
22
  ## Quick Start
24
23
 
25
- ### 1. Get GPU Key
24
+ ### 1. Get Your GPU Key
26
25
 
27
- 1. Log in to Auxot web UI
26
+ 1. Log in to [Auxot](https://auxot.com)
28
27
  2. Navigate to **Organization Settings → GPU Keys**
29
28
  3. Create a new GPU key
30
29
  4. **Configure the policy** (model, quantization, context size, capabilities)
31
30
  5. Copy the key (format: `gpu.xxxxx.yyyyy`)
32
31
 
33
- ### 2. Run Worker CLI
32
+ ### 2. Run the Worker
34
33
 
35
34
  ```bash
36
- auxot-worker --gpu-key gpu.xxxxx.yyyyy
35
+ npx @auxot/worker-cli --gpu-key gpu.xxxxx.yyyyy
37
36
  ```
38
37
 
39
38
  The worker CLI will:
@@ -47,7 +46,7 @@ The worker CLI will:
47
46
 
48
47
  ```
49
48
  --gpu-key <key> GPU authentication key (required)
50
- --auxot-url <url> Auxot platform URL (default: http://auxot.localhost:9000)
49
+ --auxot-url <url> Auxot platform URL (default: https://auxot.com)
51
50
  --debug [level] Enable debug logging (level 1 or 2, default: 1)
52
51
  --help, -h Show help message
53
52
  ```
@@ -135,22 +134,13 @@ The worker CLI generates a stable UUID on first run and stores it in `~/.auxot/g
135
134
  - Ensure GPU meets minimum context size requirements
136
135
  - Verify worker is online (check dashboard in web UI)
137
136
 
138
- ## Development
139
-
140
- ```bash
141
- # Install dependencies
142
- pnpm install
137
+ ## Support
143
138
 
144
- # Run in development mode
145
- pnpm run dev -- --gpu-key YOUR_KEY
146
-
147
- # Build for production
148
- pnpm run build
149
-
150
- # Run production build
151
- pnpm start -- --gpu-key YOUR_KEY
152
- ```
139
+ For issues, questions, or feature requests, please visit:
140
+ - [Auxot Documentation](https://auxot.com/docs)
141
+ - [GitHub Issues](https://github.com/keith301/auxot/issues)
142
+ - Email: support@auxot.com
153
143
 
154
144
  ## License
155
145
 
156
- MIT
146
+ Copyright © 2026 Auxot. All rights reserved.