@xx-in/tools
v0.1.20
Published
A command-line tool to run in any system
Downloads
4,794
Readme
tools
终端命令行工具,跨平台统一工具。
安装为全局命令
npm install -g @xx-in/tools安装完成后,终端中可使用 xx <命令> 运行各子功能。更新到最新版:
xx upgrade
# 或
npm install -g @xx-in/tools@latest
# 如果当前环境配置了其他 npm 源,可强制走官方源
xx upgrade -r临时指定 npm 官方源
如果你本机默认配置了其他 npm 源,安装、升级或发布时可以临时指定官方源,而不影响全局配置:
# 安装
npm --registry=https://registry.npmjs.org/ install -g @xx-in/tools
# 升级
npm --registry=https://registry.npmjs.org/ install -g @xx-in/tools@latest
# 发布
npm --registry=https://registry.npmjs.org/ publish --access public也可以直接使用项目内置脚本(自动 patch 升版本、同步 lock、构建并发布):
# 一键发布
npm run pub
# 强制走 npm 官方源发布
npm run publish:npm:registry功能列表
安装完成后,你可以在终端中通过 xx <命令> 运行以下功能:
1. 文件与目录管理
create <path>:递归创建文件或目录。- 若路径以
/或\结尾,则直接创建多级目录。 - 若路径不以斜杠结尾,则将其视作文件,自动确保上级目录被递归创建后,再行建立空文件。
- 若路径以
remove <path>:递归删除文件或目录。- 删除前会智能判断目标类型,并将内容删除到回收站。
copy <source> <target>:复制文件或目录。- 支持递归复制目录。若目标路径是一个已存在的文件夹,则会自动将源文件或源目录复制进该文件夹中。
move <source> <target>:移动或重命名文件及目录。- 智能检测并保证目标父目录的递归创建。若跨磁盘分区移动,程序会自动降级采用“复制+原文件删除”策略,确保正常完成。
list [path]:目录内容列出工具。- 按字典顺序对项目进行升序排序,且文件夹优先排在前面。
- 完整列出目录中的所有项目,包括以
.开头的隐藏文件和隐藏文件夹。
open [path]:文件管理器目录打开工具。- 在系统内置文件管理器中打开指定目录。若未提供参数,则默认打开当前的工作目录。
2. 本地工具安装管理
install <path>:macOS / Windows 本地工具安装器。- 支持安装单个可执行文件,以及
.zip、.tar.gz、.tgz、.tar.xz、.txz、.tar压缩包。 - 自动安装到
~/.xx-tools/apps/,并在~/.xx-tools/bin/创建终端命令入口。 - macOS 下会自动写入 Shell 配置;Windows 下会自动写入当前用户 PATH,后续即可在终端中直接调用已安装工具。
- 支持安装单个可执行文件,以及
uninstall <package>:macOS / Windows 本地工具卸载器。- 按安装名卸载工具,同时删除安装目录和终端命令入口。
3. 压缩与解压
zip [directory]:递归复制目录并根据忽略规则过滤并打包为 ZIP。- 自动检索目标目录或当前目录下的
.cpzipignore忽略配置文件。若未配置,则直接应用内置默认过滤规则(自动忽略node_modules、.git、.DS_Store、dist、*.zip等)。 - 复制过滤后的纯净项目至临时目录,打包为与目录同名的压缩包并彻底清理临时工作区。
- 自动检索目标目录或当前目录下的
unzip [zipfile]:解压 ZIP 压缩包。- 支持交互式路径输入,或直接传入 ZIP 文件。
- 可通过
-d标志自定义解压的目标文件夹。若未指定,则默认解压至当前目录下与压缩包同名的文件夹内。
4. 代码格式化
format [path]:代码格式化工具。- 调用并集成了 Prettier (v3) 工具链。支持传入单个文件或目录(自动递归扫描)。
- 自动定位并读取本地方案中配置的
.prettierrc,并对代码格式进行重写修复。
5. 系统与网络探测
ip:本地活跃网卡及网关探测。- 过滤回环地址与虚拟网卡,探测当前正在使用的物理网卡。
- 展现网卡名称、本机 IP、子网掩码、MAC 地址、IP 协议版本,并根据当前系统智能匹配探测路由出口网关。
6. 园区镜像打包下载
park [image]:园区离线打包镜像下载工具。- 支持提交 Docker 镜像至远程打包服务器进行触发任务。
- 自动解析服务器返回的跳转头部并拉取镜像结果,终端支持渲染百分比与下载进度条。
- 支持
-g配置并持久化本地的全局默认下载目录(保存于.park_config.json中)。
7. 多语言翻译
translate [text]:终端翻译工具。- 不带参数运行时,会自动进入终端交互(REPL)模式,输入
exit可退出。 - 支持智能中英双向互译:若内容包含英文字母,默认翻译为中文;否则翻译为英文。支持通过
-t手动指定强制的目标语种。
- 不带参数运行时,会自动进入终端交互(REPL)模式,输入
8. 自动补全与更新
completion [shell]:自动部署或生成 Shell 命令提示脚本。- 执行
xx completion,本工具会自动检测你当前的系统平台与正在运行的 Shell 容器,全量刷新补全定义(支持 A-Z 全称子命令推荐与各级命令的多层次 Tab 补全提示)。
- 执行
upgrade:检查并更新本工具至最新版本。- 自动重装并覆盖当前全局可执行文件,流式展示重装过程,并在重装成功后强制原地刷新覆盖本机的 Shell 自动补全脚本。
help [command]:内置命令帮助。- 显示指定命令的使用文档与参数说明。
