@xagent/x-cli 1.1.82 → 1.1.83
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 +38 -4
- package/dist/index.js +24 -40
- package/dist/index.js.map +1 -1
- package/package.json +12 -20
- package/docs/README.md +0 -212
- package/docs/assets/logos/README.md +0 -70
- package/docs/assets/logos/favicon.svg +0 -8
- package/docs/assets/logos/github-social-preview.svg +0 -39
- package/docs/assets/logos/x-cli-logo-large.svg +0 -8
- package/docs/assets/logos/x-cli-logo-small.svg +0 -8
- package/docs/assets/logos/x-cli-logo.svg +0 -8
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Test comment for PR creation -->
|
|
2
2
|
|
|
3
|
-
## 1.1.
|
|
3
|
+
## 1.1.83 – 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
|
|
|
@@ -857,13 +857,45 @@ Every push to the `main` branch automatically:
|
|
|
857
857
|
|
|
858
858
|
### What You Need to Do
|
|
859
859
|
|
|
860
|
-
|
|
860
|
+
**⚠️ CRITICAL: Use Smart Push Script Only! ⚠️**
|
|
861
|
+
|
|
862
|
+
**🚨 FOR AI AGENTS: NEVER use direct git push to main!**
|
|
861
863
|
|
|
862
864
|
```bash
|
|
865
|
+
# ✅ CORRECT METHOD - Always use smart push:
|
|
863
866
|
git add .
|
|
864
867
|
git commit -m "your feature/fix"
|
|
865
|
-
|
|
866
|
-
# ✨ Automation handles
|
|
868
|
+
npm run smart-push
|
|
869
|
+
# ✨ Automation handles quality checks + NPM publishing!
|
|
870
|
+
```
|
|
871
|
+
|
|
872
|
+
**🚫 NEVER DO THIS:**
|
|
873
|
+
|
|
874
|
+
```bash
|
|
875
|
+
git push origin main # ❌ Bypasses quality gates!
|
|
876
|
+
git push # ❌ Missing automation checks!
|
|
877
|
+
```
|
|
878
|
+
|
|
879
|
+
**💡 Why Smart Push Required:**
|
|
880
|
+
|
|
881
|
+
- Runs TypeScript & ESLint quality checks
|
|
882
|
+
- Monitors GitHub Actions workflow status
|
|
883
|
+
- Verifies NPM package publication
|
|
884
|
+
- Handles branch protection with automatic PRs
|
|
885
|
+
- Provides real-time feedback and error recovery
|
|
886
|
+
|
|
887
|
+
**📋 Complete Development Workflow:**
|
|
888
|
+
|
|
889
|
+
```bash
|
|
890
|
+
# 1. Create feature branch for development
|
|
891
|
+
git checkout -b feature/my-changes
|
|
892
|
+
# 2. Make changes and commits
|
|
893
|
+
git add . && git commit -m "implement feature"
|
|
894
|
+
# 3. Switch to main and merge
|
|
895
|
+
git checkout main
|
|
896
|
+
git merge feature/my-changes
|
|
897
|
+
# 4. Smart push to trigger NPM publish
|
|
898
|
+
npm run smart-push
|
|
867
899
|
```
|
|
868
900
|
|
|
869
901
|
### 🚨 Critical Dependencies
|
|
@@ -1116,3 +1148,5 @@ _Want to see your name here? Check out our [Contributing Guide](CONTRIBUTING.md)
|
|
|
1116
1148
|
Join our growing community of AI-powered terminal enthusiasts!
|
|
1117
1149
|
|
|
1118
1150
|
# Test: Branch Protection Rules Test
|
|
1151
|
+
|
|
1152
|
+
# test
|
package/dist/index.js
CHANGED
|
@@ -16197,7 +16197,7 @@ var init_package = __esm({
|
|
|
16197
16197
|
package_default = {
|
|
16198
16198
|
type: "module",
|
|
16199
16199
|
name: "@xagent/x-cli",
|
|
16200
|
-
version: "1.1.
|
|
16200
|
+
version: "1.1.83",
|
|
16201
16201
|
description: "An open-source AI agent that brings advanced AI capabilities directly into your terminal.",
|
|
16202
16202
|
main: "dist/index.js",
|
|
16203
16203
|
module: "dist/index.js",
|
|
@@ -16209,37 +16209,29 @@ var init_package = __esm({
|
|
|
16209
16209
|
}
|
|
16210
16210
|
},
|
|
16211
16211
|
bin: {
|
|
16212
|
-
|
|
16212
|
+
grok: "./dist/index.js"
|
|
16213
16213
|
},
|
|
16214
16214
|
files: [
|
|
16215
|
-
"dist
|
|
16216
|
-
".xcli/**/*",
|
|
16215
|
+
"dist",
|
|
16217
16216
|
"README.md",
|
|
16218
|
-
"
|
|
16219
|
-
"docs/assets/logos/**/*"
|
|
16217
|
+
"package.json"
|
|
16220
16218
|
],
|
|
16221
16219
|
scripts: {
|
|
16222
|
-
build: "tsup",
|
|
16223
|
-
|
|
16224
|
-
|
|
16225
|
-
"dev:node": "tsx src/index.ts",
|
|
16226
|
-
"dev:watch": "npm run build && node --watch dist/index.js",
|
|
16227
|
-
start: "node dist/index.js",
|
|
16228
|
-
local: "node scripts/local.js",
|
|
16229
|
-
"test:workflow": "node scripts/test-workflow.js",
|
|
16230
|
-
"start:bun": "bun run dist/index.js",
|
|
16231
|
-
lint: "eslint . --ext .js,.jsx,.ts,.tsx --ignore-pattern 'dist/**'",
|
|
16220
|
+
build: "tsup src/index.ts --format esm --dts",
|
|
16221
|
+
dev: "tsx watch src/index.ts",
|
|
16222
|
+
lint: "eslint src --ext .ts",
|
|
16232
16223
|
typecheck: "tsc --noEmit",
|
|
16233
|
-
"install:bun": "bun install",
|
|
16234
|
-
preinstall: "echo '\u{1F916} Installing X CLI...'",
|
|
16235
|
-
postinstall: `echo '==================================================' && echo '\u2705 X CLI installed successfully!' && echo '==================================================' && echo '\u{1F680} Try: xcli --help' && echo '\u{1F4A1} If "command not found", add to PATH:' && node -e "const p=process.platform;const isMac=p==='darwin';const isLinux=p==='linux';if(isMac||isLinux){const shell=isMac?'zshrc':'bashrc';console.log((isMac?'\u{1F34E} Mac':'\u{1F427} Linux')+': echo \\'export PATH=\\"$(npm config get prefix)/bin:$PATH\\"\\' >> ~/.'+shell+' && source ~/.'+shell);}" && echo '\u{1F4D6} Docs: https://github.com/hinetapora/x-cli-hurry-mode#installation' && echo '\u{1F511} Set API key: export GROK_API_KEY=your_key_here' && echo '==================================================' && echo '\u{1F527} Auto-setup PATH? Press Enter to add (or Ctrl+C to skip)' && read -t 10 && node -e "const fs=require('fs');const p=process.platform;const isMac=p==='darwin';const isLinux=p==='linux';if(isMac||isLinux){const shellFile=isMac?'.zshrc':'.bashrc';const rcPath=process.env.HOME+'/'+shellFile;const pathCmd='export PATH=\\"$(npm config get prefix)/bin:$PATH\\"';try{const content=fs.readFileSync(rcPath,'utf8');if(!content.includes(pathCmd)){fs.appendFileSync(rcPath,'\\n'+pathCmd+'\\n');console.log('\u2705 Added to ~/'+shellFile+' - restart terminal');}else{console.log('\u2139\uFE0F Already in ~/'+shellFile);}}catch(e){console.log('\u26A0\uFE0F Could not modify ~/'+shellFile+' - add manually');}}" && echo '\u{1F50D} Verifying: ' && xcli --version 2>/dev/null || echo '\u26A0\uFE0F xcli not in PATH yet - follow above steps'`,
|
|
16236
16224
|
prepare: "husky install",
|
|
16237
16225
|
"dev:site": "cd apps/site && npm run start",
|
|
16238
16226
|
"build:site": "cd apps/site && npm run build",
|
|
16239
16227
|
"sync:docs": "cd apps/site && node src/scripts/sync-agent-docs.js",
|
|
16240
|
-
"smart-push": "./scripts/smart-push.sh"
|
|
16228
|
+
"smart-push": "./scripts/smart-push.sh",
|
|
16229
|
+
push: "echo '\u{1F6A8} BLOCKED: Use npm run smart-push instead' && echo '\u{1F4A1} Direct git push bypasses automation' && exit 1",
|
|
16230
|
+
"git-push": "echo '\u{1F6A8} BLOCKED: Use npm run smart-push instead' && echo '\u{1F4A1} Direct git push bypasses automation' && exit 1"
|
|
16241
16231
|
},
|
|
16242
16232
|
"lint-staged": {
|
|
16233
|
+
".agent/**/*.{md,mdx}": "prettier --write",
|
|
16234
|
+
"apps/site/docs/**/*.{md,mdx}": [],
|
|
16243
16235
|
"*.{ts,tsx}": [
|
|
16244
16236
|
"eslint --fix --ignore-pattern 'dist/**'"
|
|
16245
16237
|
],
|
|
@@ -21786,7 +21778,7 @@ var require_package = __commonJS({
|
|
|
21786
21778
|
module.exports = {
|
|
21787
21779
|
type: "module",
|
|
21788
21780
|
name: "@xagent/x-cli",
|
|
21789
|
-
version: "1.1.
|
|
21781
|
+
version: "1.1.83",
|
|
21790
21782
|
description: "An open-source AI agent that brings advanced AI capabilities directly into your terminal.",
|
|
21791
21783
|
main: "dist/index.js",
|
|
21792
21784
|
module: "dist/index.js",
|
|
@@ -21798,37 +21790,29 @@ var require_package = __commonJS({
|
|
|
21798
21790
|
}
|
|
21799
21791
|
},
|
|
21800
21792
|
bin: {
|
|
21801
|
-
|
|
21793
|
+
grok: "./dist/index.js"
|
|
21802
21794
|
},
|
|
21803
21795
|
files: [
|
|
21804
|
-
"dist
|
|
21805
|
-
".xcli/**/*",
|
|
21796
|
+
"dist",
|
|
21806
21797
|
"README.md",
|
|
21807
|
-
"
|
|
21808
|
-
"docs/assets/logos/**/*"
|
|
21798
|
+
"package.json"
|
|
21809
21799
|
],
|
|
21810
21800
|
scripts: {
|
|
21811
|
-
build: "tsup",
|
|
21812
|
-
|
|
21813
|
-
|
|
21814
|
-
"dev:node": "tsx src/index.ts",
|
|
21815
|
-
"dev:watch": "npm run build && node --watch dist/index.js",
|
|
21816
|
-
start: "node dist/index.js",
|
|
21817
|
-
local: "node scripts/local.js",
|
|
21818
|
-
"test:workflow": "node scripts/test-workflow.js",
|
|
21819
|
-
"start:bun": "bun run dist/index.js",
|
|
21820
|
-
lint: "eslint . --ext .js,.jsx,.ts,.tsx --ignore-pattern 'dist/**'",
|
|
21801
|
+
build: "tsup src/index.ts --format esm --dts",
|
|
21802
|
+
dev: "tsx watch src/index.ts",
|
|
21803
|
+
lint: "eslint src --ext .ts",
|
|
21821
21804
|
typecheck: "tsc --noEmit",
|
|
21822
|
-
"install:bun": "bun install",
|
|
21823
|
-
preinstall: "echo '\u{1F916} Installing X CLI...'",
|
|
21824
|
-
postinstall: `echo '==================================================' && echo '\u2705 X CLI installed successfully!' && echo '==================================================' && echo '\u{1F680} Try: xcli --help' && echo '\u{1F4A1} If "command not found", add to PATH:' && node -e "const p=process.platform;const isMac=p==='darwin';const isLinux=p==='linux';if(isMac||isLinux){const shell=isMac?'zshrc':'bashrc';console.log((isMac?'\u{1F34E} Mac':'\u{1F427} Linux')+': echo \\'export PATH=\\"$(npm config get prefix)/bin:$PATH\\"\\' >> ~/.'+shell+' && source ~/.'+shell);}" && echo '\u{1F4D6} Docs: https://github.com/hinetapora/x-cli-hurry-mode#installation' && echo '\u{1F511} Set API key: export GROK_API_KEY=your_key_here' && echo '==================================================' && echo '\u{1F527} Auto-setup PATH? Press Enter to add (or Ctrl+C to skip)' && read -t 10 && node -e "const fs=require('fs');const p=process.platform;const isMac=p==='darwin';const isLinux=p==='linux';if(isMac||isLinux){const shellFile=isMac?'.zshrc':'.bashrc';const rcPath=process.env.HOME+'/'+shellFile;const pathCmd='export PATH=\\"$(npm config get prefix)/bin:$PATH\\"';try{const content=fs.readFileSync(rcPath,'utf8');if(!content.includes(pathCmd)){fs.appendFileSync(rcPath,'\\n'+pathCmd+'\\n');console.log('\u2705 Added to ~/'+shellFile+' - restart terminal');}else{console.log('\u2139\uFE0F Already in ~/'+shellFile);}}catch(e){console.log('\u26A0\uFE0F Could not modify ~/'+shellFile+' - add manually');}}" && echo '\u{1F50D} Verifying: ' && xcli --version 2>/dev/null || echo '\u26A0\uFE0F xcli not in PATH yet - follow above steps'`,
|
|
21825
21805
|
prepare: "husky install",
|
|
21826
21806
|
"dev:site": "cd apps/site && npm run start",
|
|
21827
21807
|
"build:site": "cd apps/site && npm run build",
|
|
21828
21808
|
"sync:docs": "cd apps/site && node src/scripts/sync-agent-docs.js",
|
|
21829
|
-
"smart-push": "./scripts/smart-push.sh"
|
|
21809
|
+
"smart-push": "./scripts/smart-push.sh",
|
|
21810
|
+
push: "echo '\u{1F6A8} BLOCKED: Use npm run smart-push instead' && echo '\u{1F4A1} Direct git push bypasses automation' && exit 1",
|
|
21811
|
+
"git-push": "echo '\u{1F6A8} BLOCKED: Use npm run smart-push instead' && echo '\u{1F4A1} Direct git push bypasses automation' && exit 1"
|
|
21830
21812
|
},
|
|
21831
21813
|
"lint-staged": {
|
|
21814
|
+
".agent/**/*.{md,mdx}": "prettier --write",
|
|
21815
|
+
"apps/site/docs/**/*.{md,mdx}": [],
|
|
21832
21816
|
"*.{ts,tsx}": [
|
|
21833
21817
|
"eslint --fix --ignore-pattern 'dist/**'"
|
|
21834
21818
|
],
|