@fre4x/grok 1.0.42 → 1.0.45

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.
Files changed (3) hide show
  1. package/README.md +18 -8
  2. package/dist/index.js +16699 -8869
  3. package/package.json +4 -2
package/README.md CHANGED
@@ -10,17 +10,25 @@ xAI's Grok is more than an LLM. It's a real-time sensor for the global conscious
10
10
 
11
11
  | Tool | Capability |
12
12
  |------|------------|
13
- | `x_search` | Real-time search of X (Twitter) posts, users, and threads |
14
- | `web_search` | Reasoning-based web search using Grok's latest models |
13
+ | `grok_search_x` | Search X posts and threads with optional date and handle filters |
14
+ | `grok_search_web` | Search the public web with optional domain filters |
15
15
  | `grok_imagine` | Generate high-quality images from text prompts |
16
- | `grok_animate` | Generate or animate video from text or image prompts (Asynchronous) |
17
- | `check_video_status` | Check the status of a video generation task via its request ID |
16
+ | `grok_animate` | Start an asynchronous video generation task |
17
+ | `grok_check_video_status` | Check the status of a video generation task |
18
+
19
+ Search tools support `limit` and `offset` pagination and return normalized results with citations.
18
20
 
19
21
  ## Configuration
20
22
 
21
- Required Environment Variable:
23
+ Required environment variable:
22
24
  - `XAI_API_KEY`: Your xAI API key from [console.x.ai](https://console.x.ai/).
23
25
 
26
+ Mock mode is supported for local development and offline validation:
27
+
28
+ ```bash
29
+ MOCK=true npx @fre4x/grok
30
+ ```
31
+
24
32
  ## Deploy
25
33
 
26
34
  ```json
@@ -41,9 +49,11 @@ Required Environment Variable:
41
49
 
42
50
  ```bash
43
51
  npm install
44
- npm run dev # tsx, no build
45
- npm run build # esbuild → dist/
46
- npm run typecheck # tsc verification
52
+ npm run dev
53
+ npm run build
54
+ npm run typecheck
55
+ npm test
56
+ npm run inspector
47
57
  ```
48
58
 
49
59
  ## License