@xagent/x-cli 1.1.76 → 1.1.78
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 +26 -26
- package/dist/index.js +412 -78
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Test comment for PR creation -->
|
|
2
2
|
|
|
3
|
-
## 1.1.
|
|
3
|
+
## 1.1.78 – Logo Assets & NPM Publication Complete
|
|
4
4
|
|
|
5
5
|
✅ **Live on NPM**: [@xagent/x-cli](https://www.npmjs.com/package/@xagent/x-cli) - Fully published and ready for global installation
|
|
6
6
|
|
|
@@ -21,7 +21,7 @@ This release includes corrected logo assets and complete automated publishing pi
|
|
|
21
21
|
[](https://github.com/x-cli-team/x-cli/blob/main/LICENSE)
|
|
22
22
|
[](https://discord.com/channels/1315720379607679066/1315822328139223064)
|
|
23
23
|
|
|
24
|
-
A conversational AI CLI tool powered by
|
|
24
|
+
A conversational AI CLI tool powered by x.ai with **Claude Code-level intelligence** and advanced tool capabilities.
|
|
25
25
|
|
|
26
26
|
<div align="center">
|
|
27
27
|
<img src="docs/assets/logos/x-cli-logo-large.svg" alt="X CLI Logo" width="120" />
|
|
@@ -41,7 +41,7 @@ A conversational AI CLI tool powered by Grok with **Claude Code-level intelligen
|
|
|
41
41
|
|
|
42
42
|
- **🎯 Shift+Tab Twice Activation**: Exact Claude Code Plan Mode with read-only exploration
|
|
43
43
|
- **🔍 Comprehensive Codebase Analysis**: Project structure, dependencies, complexity metrics, and architecture patterns
|
|
44
|
-
- **🧠 AI-Powered Implementation Planning**: Strategic plan generation using
|
|
44
|
+
- **🧠 AI-Powered Implementation Planning**: Strategic plan generation using x.ai models with risk assessment
|
|
45
45
|
- **🛡️ Read-Only Tool Execution**: Safe exploration with destructive operation blocking and simulation
|
|
46
46
|
- **📊 Progress Visualization**: Real-time exploration and planning progress with phase-specific guidance
|
|
47
47
|
- **📋 User Approval Workflow**: Complete plan review and confirmation before execution
|
|
@@ -103,7 +103,7 @@ A conversational AI CLI tool powered by Grok with **Claude Code-level intelligen
|
|
|
103
103
|
|
|
104
104
|
- **🎯 Shift+Tab Twice**: Activate read-only exploration mode (exact Claude Code parity)
|
|
105
105
|
- **🔍 Codebase Analysis**: Comprehensive project structure, dependencies, and complexity analysis
|
|
106
|
-
- **🧠 AI-Powered Planning**: Strategic implementation plans generated by
|
|
106
|
+
- **🧠 AI-Powered Planning**: Strategic implementation plans generated by x.ai models
|
|
107
107
|
- **🛡️ Read-Only Safety**: Zero file modifications during exploration with tool simulation
|
|
108
108
|
- **📊 Progress Tracking**: Real-time exploration progress with phase-specific guidance
|
|
109
109
|
- **📋 Plan Approval**: Review and approve implementation plans before execution
|
|
@@ -128,7 +128,7 @@ A conversational AI CLI tool powered by Grok with **Claude Code-level intelligen
|
|
|
128
128
|
|
|
129
129
|
### 🤖 **Core AI Capabilities**
|
|
130
130
|
|
|
131
|
-
- **💬 Conversational Interface**: Natural language powered by
|
|
131
|
+
- **💬 Conversational Interface**: Natural language powered by x.ai models
|
|
132
132
|
- **🔧 Intelligent Tool Selection**: AI automatically chooses the right tools for your requests
|
|
133
133
|
- **⚡ Bash Integration**: Execute shell commands through natural conversation
|
|
134
134
|
- **🔌 MCP Extension**: Extend capabilities with Model Context Protocol servers (Linear, GitHub, etc.)
|
|
@@ -277,7 +277,7 @@ npm link
|
|
|
277
277
|
|
|
278
278
|
## Setup
|
|
279
279
|
|
|
280
|
-
1. Get your
|
|
280
|
+
1. Get your x.ai API key from [X.AI](https://x.ai)
|
|
281
281
|
|
|
282
282
|
2. Set up your API key (choose one method):
|
|
283
283
|
|
|
@@ -328,7 +328,7 @@ MORPH_API_KEY=your_morph_api_key_here
|
|
|
328
328
|
|
|
329
329
|
### Custom Base URL (Optional)
|
|
330
330
|
|
|
331
|
-
By default, the CLI uses `https://api.x.ai/v1` as the
|
|
331
|
+
By default, the CLI uses `https://api.x.ai/v1` as the x.ai API endpoint. You can configure a custom endpoint if needed (choose one method):
|
|
332
332
|
|
|
333
333
|
**Method 1: Environment Variable**
|
|
334
334
|
|
|
@@ -356,13 +356,13 @@ Add to `~/.xcli/user-settings.json`:
|
|
|
356
356
|
|
|
357
357
|
X CLI uses two types of configuration files to manage settings:
|
|
358
358
|
|
|
359
|
-
### User-Level Settings (`~/.
|
|
359
|
+
### User-Level Settings (`~/.xcli/config.json`)
|
|
360
360
|
|
|
361
361
|
This file stores **global settings** that apply across all projects. These settings rarely change and include:
|
|
362
362
|
|
|
363
|
-
- **API Key**: Your
|
|
363
|
+
- **API Key**: Your x.ai API key
|
|
364
364
|
- **Base URL**: Custom API endpoint (if needed)
|
|
365
|
-
- **Default Model**: Your preferred model (e.g., `grok-
|
|
365
|
+
- **Default Model**: Your preferred model (e.g., `grok-4-fast-non-reasoning`)
|
|
366
366
|
- **Available Models**: List of models you can use
|
|
367
367
|
|
|
368
368
|
**Example:**
|
|
@@ -371,9 +371,9 @@ This file stores **global settings** that apply across all projects. These setti
|
|
|
371
371
|
{
|
|
372
372
|
"apiKey": "your_api_key_here",
|
|
373
373
|
"baseURL": "https://api.x.ai/v1",
|
|
374
|
-
"defaultModel": "grok-
|
|
374
|
+
"defaultModel": "grok-4-fast-non-reasoning",
|
|
375
375
|
"models": [
|
|
376
|
-
"grok-
|
|
376
|
+
"grok-4-fast-non-reasoning",
|
|
377
377
|
"grok-4-latest",
|
|
378
378
|
"grok-3-latest",
|
|
379
379
|
"grok-3-fast",
|
|
@@ -382,7 +382,7 @@ This file stores **global settings** that apply across all projects. These setti
|
|
|
382
382
|
}
|
|
383
383
|
```
|
|
384
384
|
|
|
385
|
-
### Project-Level Settings (`.
|
|
385
|
+
### Project-Level Settings (`.xcli/settings.json`)
|
|
386
386
|
|
|
387
387
|
This file stores **project-specific settings** in your current working directory. It includes:
|
|
388
388
|
|
|
@@ -410,7 +410,7 @@ This file stores **project-specific settings** in your current working directory
|
|
|
410
410
|
1. **Global Defaults**: User-level settings provide your default preferences
|
|
411
411
|
2. **Project Override**: Project-level settings override defaults for specific projects
|
|
412
412
|
3. **Directory-Specific**: When you change directories, project settings are loaded automatically
|
|
413
|
-
4. **Fallback Logic**: Project model → User default model → System default (`grok-
|
|
413
|
+
4. **Fallback Logic**: Project model → User default model → System default (`grok-4-fast-non-reasoning`)
|
|
414
414
|
|
|
415
415
|
This means you can have different models for different projects while maintaining consistent global settings like your API key.
|
|
416
416
|
|
|
@@ -420,7 +420,7 @@ This means you can have different models for different projects while maintainin
|
|
|
420
420
|
|
|
421
421
|
**Popular Providers**:
|
|
422
422
|
|
|
423
|
-
- **X.AI
|
|
423
|
+
- **X.AI**: `https://api.x.ai/v1` (default)
|
|
424
424
|
- **OpenAI**: `https://api.openai.com/v1`
|
|
425
425
|
- **OpenRouter**: `https://openrouter.ai/api/v1`
|
|
426
426
|
- **Groq**: `https://api.groq.com/openai/v1`
|
|
@@ -444,7 +444,7 @@ This means you can have different models for different projects while maintainin
|
|
|
444
444
|
|
|
445
445
|
### 🎯 **Best Feature of X CLI - AI Context Optimization**
|
|
446
446
|
|
|
447
|
-
The **`.agent` folder** is the most powerful feature of X CLI, enabling **self-documenting AI workflows** that automatically provide context to AI agents. This revolutionary approach ensures every AI interaction is informed by comprehensive project documentation, making conversations with
|
|
447
|
+
The **`.agent` folder** is the most powerful feature of X CLI, enabling **self-documenting AI workflows** that automatically provide context to AI agents. This revolutionary approach ensures every AI interaction is informed by comprehensive project documentation, making conversations with x.ai models significantly more productive and accurate.
|
|
448
448
|
|
|
449
449
|
### 🏗️ **How It Works**
|
|
450
450
|
|
|
@@ -646,8 +646,8 @@ You can specify which AI model to use with the `--model` parameter or `GROK_MODE
|
|
|
646
646
|
**Method 1: Command Line Flag**
|
|
647
647
|
|
|
648
648
|
```bash
|
|
649
|
-
# Use
|
|
650
|
-
xcli --model grok-
|
|
649
|
+
# Use x.ai models
|
|
650
|
+
xcli --model grok-4-fast-non-reasoning
|
|
651
651
|
xcli --model grok-4-latest
|
|
652
652
|
xcli --model grok-3-latest
|
|
653
653
|
xcli --model grok-3-fast
|
|
@@ -660,7 +660,7 @@ xcli --model claude-sonnet-4-20250514 --base-url https://api-endpoint.com/v1
|
|
|
660
660
|
**Method 2: Environment Variable**
|
|
661
661
|
|
|
662
662
|
```bash
|
|
663
|
-
export GROK_MODEL=grok-
|
|
663
|
+
export GROK_MODEL=grok-4-fast-non-reasoning
|
|
664
664
|
xcli
|
|
665
665
|
```
|
|
666
666
|
|
|
@@ -670,11 +670,11 @@ Add to `~/.xcli/user-settings.json`:
|
|
|
670
670
|
```json
|
|
671
671
|
{
|
|
672
672
|
"apiKey": "your_api_key_here",
|
|
673
|
-
"defaultModel": "grok-
|
|
673
|
+
"defaultModel": "grok-4-fast-non-reasoning"
|
|
674
674
|
}
|
|
675
675
|
```
|
|
676
676
|
|
|
677
|
-
**Model Priority**: `--model` flag > `GROK_MODEL` environment variable > user default model > system default (grok-
|
|
677
|
+
**Model Priority**: `--model` flag > `GROK_MODEL` environment variable > user default model > system default (grok-4-fast-non-reasoning)
|
|
678
678
|
|
|
679
679
|
### Command Line Options
|
|
680
680
|
|
|
@@ -684,9 +684,9 @@ xcli [options]
|
|
|
684
684
|
Options:
|
|
685
685
|
-V, --version output the version number
|
|
686
686
|
-d, --directory <dir> set working directory
|
|
687
|
-
-k, --api-key <key>
|
|
688
|
-
-u, --base-url <url>
|
|
689
|
-
-m, --model <model> AI model to use (e.g., grok-
|
|
687
|
+
-k, --api-key <key> x.ai API key (or set X_API_KEY env var)
|
|
688
|
+
-u, --base-url <url> x.ai API base URL (or set GROK_BASE_URL env var)
|
|
689
|
+
-m, --model <model> AI model to use (e.g., grok-4-fast-non-reasoning, grok-4-latest) (or set GROK_MODEL env var)
|
|
690
690
|
-p, --prompt <prompt> process a single prompt and exit (headless mode)
|
|
691
691
|
--max-tool-rounds <rounds> maximum number of tool execution rounds (default: 400)
|
|
692
692
|
-h, --help display help for command
|
|
@@ -712,7 +712,7 @@ Always add JSDoc comments for public functions and interfaces.
|
|
|
712
712
|
Follow the existing code style and patterns in this project.
|
|
713
713
|
```
|
|
714
714
|
|
|
715
|
-
|
|
715
|
+
X CLI will automatically load and follow these instructions when working in your project directory. The custom instructions are added to the AI model's system prompt and take priority over default behavior.
|
|
716
716
|
|
|
717
717
|
## Morph Fast Apply (Optional)
|
|
718
718
|
|
|
@@ -1051,7 +1051,7 @@ curl -I https://api.x.ai/v1/models
|
|
|
1051
1051
|
- **File operations fail**: Check that the file path exists and is accessible
|
|
1052
1052
|
- **Bash commands fail**: Ensure you have the necessary permissions
|
|
1053
1053
|
- **Tool timeouts**: Complex operations may take time; the spinner indicates progress
|
|
1054
|
-
- **Slow responses**: Try a different model with `xcli --model grok-
|
|
1054
|
+
- **Slow responses**: Try a different model with `xcli --model grok-4-fast-non-reasoning`
|
|
1055
1055
|
|
|
1056
1056
|
## 🙏 Credits
|
|
1057
1057
|
|