Skip to content

About

简单的一个命令行工具,可以预设命令,快捷粘贴到粘贴板

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

Repository files navigation

HK CLI

键盘驱动的终端命令剪贴板工具。

从交互菜单中选择一个命令,自动复制到剪贴板,然后粘贴到终端即可。再也不用记长命令了。

工作原理

$ hk

  ╔══════════════════════════════════════════════════════╗
  ║                    HK CLI                            ║
  ╚══════════════════════════════════════════════════════╝

  [1] Dou Bao Prompt — 提取 PPT/PDF 知识点
  [2] Git Log — 显示提交历史
  [3] List Files — 列出目录内容
  ...

  > _     <-- 按一个键,命令就复制到剪贴板了

按一个数字键,命令就复制到剪贴板,直接粘贴到终端就能用。

安装

前置要求

Windows

git clone <仓库地址> hk4
cd hk4
install.bat                    # 默认命令名:hk
install.bat --name wjx         # 自定义命令名:wjx

安装器会:

  • 提示输入命令名(或通过 --name 参数指定)
  • 验证名称(字母数字,无空格)
  • 检查 Node.js 版本(>= 14)
  • 安装到 %USERPROFILE%\.config\hk
  • 安装前备份已有配置
  • 自动添加到 PATH(通过 PowerShell)
  • 创建版本标记,方便后续更新
  • 安装后验证命令是否可用

运行 install.bat /silent 可静默安装(跳过 pause)。 组合使用:install.bat --name wjx /silent

Linux / macOS

git clone <仓库地址> hk4
cd hk4
chmod +x install.sh
bash install.sh                # 默认命令名:hk
bash install.sh --name wjx     # 自定义命令名:wjx

安装器会:

  • 提示输入命令名(或通过 --name 参数指定)
  • 验证名称(字母数字,无空格)
  • 检测平台(macOS / Linux)
  • 检查 Node.js 版本(>= 14)
  • 检查剪贴板工具(pbcopy / xclip / xsel / wl-copy)
  • 安装到 ~/.config/hk
  • 安装前备份已有配置
  • 通过 ~/.bashrc 和/或 ~/.zshrc 添加到 PATH
  • 创建 hk 软链接(如指定了自定义名称,同时创建对应软链接)
  • 安装后验证命令是否可用

使用方法

hk                    交互式菜单(按键复制命令)
hk <key>              直接复制命令(如 hk 1)
hk -l                 列出所有配置
hk -u <file.json>     导入配置文件
hk -t <name>          切换当前配置(如 hk -t hk1)
hk -h                 显示帮助

配置

配置文件存放在 ~/.config/hk/,格式如下:

{
  "name": "我的命令",
  "desc": "配置描述",
  "commands": [
    {
      "name": "命令名称",
      "key": "1",
      "desc": "命令说明",
      "cmd": "unix 命令",
      "cmd_win": "windows 命令"
    }
  ]
}

字段说明

字段 必填 说明
name 是 配置显示名称
desc 否 配置描述
commands[].name 是 命令显示名称
commands[].key 是 单字符快捷键
commands[].desc 否 命令说明
commands[].cmd 是 Unix/macOS 命令
commands[].cmd_win 否 Windows 命令(不填则用 cmd)

导入配置

hk -u my-commands.json

文件会自动复制到 ~/.config/hk/,并自动分配文件名(hk.json、hk1.json、hk2.json……)。

切换配置

hk -t hk1          # 按文件名切换
hk -t "我的命令"    # 按配置名称切换
hk -l              # 列出所有可用配置

环境变量

变量 默认值 说明
HK_CONFIG_DIR ~/.config/hk 自定义配置目录
HK_DEFAULT_CONFIG hk 自定义默认配置名

示例:

HK_CONFIG_DIR=/tmp/hk-config hk       # 使用自定义配置目录
HK_DEFAULT_CONFIG=myprofile hk         # 默认使用 myprofile.json

文件说明

安装后 ~/.config/hk/ 目录下的文件:

文件 用途
hk.js 主脚本
hk.cmd Windows 入口
hk.json 默认配置
.hk_state 当前激活的配置名
.hk_history 命令历史记录
.hk_version 已安装版本号
.hk_command_name 自定义命令名
backup_YYYYMMDD/ 配置备份

卸载

Windows

:: 删除安装目录
rmdir /s /q "%USERPROFILE%\.config\hk"

:: 删除 PATH 中的条目(如果自动添加过)
:: 打开 系统属性 > 环境变量,手动删除对应条目

Linux / macOS

# 删除安装目录
rm -rf ~/.config/hk

# 从 shell 配置中删除 PATH 条目
# 编辑 ~/.bashrc 和/或 ~/.zshrc,删除 "# HK CLI" 那一段

About

简单的一个命令行工具,可以预设命令,快捷粘贴到粘贴板

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages