一个类Unix命令行辅助工具。
cheat 是什么
cheat是一个命令行辅助工具,适用于类Unix的系统,可以称之为命令惯用备忘小抄。
cheat跟man和info等命令帮助文档的区别是高效实用,如果说man提供的是完整理论知识,那cheat提供的就是实践经验。
cheat新版本使用Go语言开发,旧版本是用Python语言开发。
cheat的特点:提供公共的备忘单小抄大全,还可以加入自定义的备忘小抄,定制属于自己的命令辅助备忘小抄。
cheat 有什么用
为类Unix命令行辅助,再也不怕记不住命令的用法了,通过cheat快速找到命令惯用的例子,直奔命令的使用,不需要看太多累赘的命令参数解析。
cheat 相关资源
- 源码仓库地址
https://github.com/cheat/cheat
- 发行版地址
https://github.com/cheat/cheat/releases
- 社区备忘表地址
https://github.com/cheat/cheatsheets/
- 在线Web版地址
cheat 安装
cheat新版本使用Go语言开发,以至于找到的安装资料都是说Python语言开发的旧版本安装方法。
本文解决的是新版本cheat手动通用安装方法,不依赖其它语言环境。
Linux系统上安装
1、 切换到临时目录
cd /tmp
2、 使用wget命令下载,注意替换适合的版本号和压缩包名,可以查看章节【cheat 相关资源】,获取最新资源。
# 4.3.1 版本号替换最新的版本号
# cheat-linux-amd64.gz 压缩包替换适合对应系统的压缩包
wget https://github.com/cheat/cheat/releases/download/4.3.1/cheat-linux-amd64.gz
3、 解压文件
gunzip cheat-linux-amd64.gz
4、 添加可执行权限
chmod +x cheat-linux-amd64
5、 把二进制文件移动到命令目录
sudo mv cheat-linux-amd64 /usr/local/bin/cheat
配置conf.yml
1、 执行命令cheat
2、 按提示步骤,确认是否[Y/n]创建conf.yml配置文件,输入“y”确认创建它,确认是否[Y/n]克隆社区备忘表,输入“y”确认克隆下载社区备忘表,这个动作需要Git工具配合,如果未安装Git,否则克隆失败。
社区备忘表是cheat的重要部分,Git克隆失败,可以手动下载,可以查看章节【cheat 相关资源】,获取下载社区备忘表。
3、 查看配置目录和配置文件是否存在
# 查看配置目录及配置文件
ls -l ~/.config/cheat
# 未存在配置目录,需要创建配置目录
mkdir -p ~/.config/cheat
# 未存在配置文件,需要创建配置文件
cheat --init > ~/.config/cheat/conf.yml
4、 修改conf.yml配置文件
打开编辑
vi ~/.config/cheat/conf.yml
-
配置默认编辑器为vi
editor: /usr/bin/vi
配置社区备忘表path路径和自定义备忘表path路径
修改tags标签为简短名字,方便命令参数中使用
备忘表路径配置优先级,后面的会覆盖前面的显示,可以通过参数
-t <tags>
指定备忘表显示保存退出编辑
至此,通过cheat的安装、配置,可以正常使用。
不过,配置只对当前登录用户有效,其他用户要使用cheat,需要进行同样的配置后,才能正常使用。
cheat 使用
# 列出cheat的帮助信息
cheat
# 查看cheat的备忘
cheat cheat
# 查看tar的备忘
cheat tar
# 指定备忘表标签显示
cheat tar -t <tag>
分页显示
cheat内容太多,无法一屏显示完整,需要结合more或less分页显示。
# 分页显示cheat
cheat tar | more
cheat tar | less
多用户共用社区备忘表
多用户使用cheat场景,进行同样配置,可能会重复克隆下载社区备忘表,为了节约磁盘空间,多用户配置cheat共用同一个路径的社区备忘表。
登录的用户,使用cheat,不存在配置文件,都会提示是否要创建配置文件和克隆社区备忘表。
1、 当前用户没有cheat配置,执行任意cheat命令,触发创建配置文件提示
- 按提示步骤,确认是否[Y/n]创建conf.yml配置文件,输入“y”确认创建它
- 确认是否[Y/n]克隆社区备忘表,输入“n”取消克隆下载社区备忘表
2、 查看配置目录和配置文件是否存在
# 查看配置目录及配置文件
ls -l ~/.config/cheat
# 未存在配置目录,需要创建配置目录
mkdir -p ~/.config/cheat
# 未存在配置文件,需要创建配置文件
cheat --init > ~/.config/cheat/conf.yml
3、 修改conf.yml配置文件
- 打开编辑
vi ~/.config/cheat/conf.yml
- 配置默认编辑器为vi
editor: /usr/bin/vi
- 配置社区备忘表path路径和自定义备忘表path路径
- 修改社区备忘表为共用社区备忘表所在的路径,注意共用路径是否有权限
- 修改tags标签为简短名字,方便命令参数中使用
- 备忘表路径配置优先级,后面的会覆盖前面的显示,可以通过参数
-t <tags>
指定备忘表显示 - 保存退出编辑
4、 根据配置,创建个人自定义备忘表目录,如果,配置找不到目录,使用cheat会报错
# 创建个人自定义备忘表目录
mkdir -p ~/.config/cheat/me