quick-command

English Version

一个轻量级的命令行工具，用于创建快捷命令别名，提高开发效率。通过将常用的长命令简化为短别名，快速执行各种开发相关操作。

项目介绍

quick-command 是一个命令行工具，允许用户为常用命令创建简短别名。它特别适用于需要频繁执行的复杂命令，如 Node.js、NPM、Git 等工具链中的命令。通过使用 quick-cmd，您可以将 git commit -m "message" 简化为 gc "message"，或将 npm install -g @vue/cli 简化为 nig @vue/cli。

该工具会在用户主目录下创建 .quick-cmd 目录来存储配置和命令别名，并支持导入/导出配置。

项目优势

1. 提高效率：将常用的复杂命令简化为短别名，减少输入时间
2. 易于使用：提供直观的命令行界面，简单易学
3. 灵活配置：支持添加、删除、查看和管理命令别名
4. 持久化存储：配置保存在用户主目录中，跨会话使用

安装

npm install -g quick-command

或者使用 yarn：

yarn global add quick-command

安装后可以使用 qcmd 命令。

命令说明

| 命令 | 别名 | 描述 | |------|------|------| | install | i | 从 JSON 文件安装命令 | | add | a | 添加新命令 | | delete | d or r or remove| 删除命令 | | list | l or list | 列出所有命令 | | preview | p | 预览命令信息 | | export | e | 导出命令到 JSON 文件 |

命令详解

install (i) - 从 JSON 文件安装命令

参数：

• [jsonPath] - JSON 文件路径，默认使用内置配置

示例配置文件：

{
    "gs": "git status",
    "gc": "git commit -m \"{{arg}}\"",
    "nv": "node -v"
}

使用示例：

qcmd install                 # 安装默认命令
qcmd i ./my-commands.json   # 从指定文件安装命令

默认命令 见：默认命令

add (a) - 添加新命令到配置文件

参数：

• alias - 命令别名
• command - 实际要执行的命令

使用示例：

qcmd add gs "git status"                           # 添加简单命令别名
qcmd a gc "git commit -m \"{{arg}}\""             # 添加带参数的命令别名
qcmd a nr "npm run {{arg}}"                       # 添加带参数的npm命令别名

delete (d) - 删除命令

参数：

• [alias] - 要删除的命令别名，如果不提供则删除所有命令

使用示例：

qcmd delete gs     # 删除 gs 命令
qcmd d gc          # 删除 gc 命令
qcmd d        # 删除所有命令

list (l) - 列出所有已配置的命令

使用示例：

qcmd list
# or
qcmd l

preview (p) - 预览命令信息

参数：

• alias - 要预览的命令别名 选项：
• -f, --full - 显示完整的命令内容

使用示例：

qcmd preview gc     # 查看 gc 命令
qcmd p gc -f        # 查看 gc 命令完整内容
qcmd p nr           # 查看 nr 命令

export (e) - 导出命令到指定的 JSON 文件

参数：

• [jsonPath] - 导出的 JSON 文件路径

使用示例：

qcmd export ./my-commands.json    # 导出命令到指定文件
qcmd e ./backup.json             # 导出命令到备份文件

添加到 PATH（重要）

使用 qcmd i 安装命令后，您需要将命令目录添加到系统的 PATH 环境变量中，才能直接在终端中使用这些快捷命令。

macOS 和 Linux 用户：

将以下行添加到您的 shell 配置文件（~/.bashrc、~/.zshrc 等）中：

export PATH="$HOME/.quick-cmd/bin:$PATH"

然后重新加载您的 shell 配置：

source ~/.bashrc   # 或 source ~/.zshrc

默认命令

如果安装默认命令，工具会创建以下命令：

{
    "nv": "node -v",

    "c": "clear",

    "ni": "npm i",
    "nr": "npm run {{arg}}",

    "ggs": "git status",
    "gadd": "git add {{arg}}",
    "gpush": "git push origin HEAD",
    "ggl": "git pull",
    "ggi": "git init",
    "ggc": "git commit -m '{{arg}}'",
    
    "yi": "yarn install",
    "ya": "yarn add {{arg}}",
    "y": "yarn",
    "yr": "yarn {{arg}}"
}