一个简单的命令行代码段管理器
snipster-p的Python项目详细描述
狙击手
A simple cli snippet manager
snipster是一个命令行代码段管理器,允许您从命令行查看、编辑、创建和复制代码段。它遵循unix的“做一件事,做好它”的理念。
Installation{a6}{a7}{a8}{a9}{a10}
安装
狙击手在PyPI上可用。这是最简单的安装方法。所有依赖项都将自动安装。
pip3 install snipster-py
如果要从源代码安装snipster,请查看here
设置
当您第一次启动狙击手时,应运行
snipster source
这将在您的主文件夹中创建一个^ {CD1>}目录(如果它还不存在),并创建一个空片段列表。
用法
snipster source
snipster list
snipster list [-t <tag>... | -l <language>... | -k <keyword>... ]...
snipster (-c|-e|-o) [-f] <snippet-id>
snipster -h | --help
snipster -v | --version
列出(并筛选)所有片段
您可以按标记(-t
)、标题中的关键字(-k
)和语言(-l
)进行筛选。如果筛选结果只有一个匹配项,则将直接显示匹配项(而不是只有一个条目的列表)。
创建/编辑片段
创建代码段时,将在~/.snipster
中创建一个空文件,并在$EDITOR
中打开。若要将此代码段视为有效,它需要具有yaml frontmatter,并且实际的代码段代码需要标记为有效。你不需要在前面的事情上有任何属性,但他们是非常鼓励的。有效属性是tags
、lang
、title
。
不需要一个id。当您再次输入源代码时,它将由狙击手自动分配。
为了识别(对)代码片段的更改,您需要在保存后snipster source
。
查看片段
将片段复制到剪贴板
故障排除
错误报告和功能请求
非常感谢错误报告和功能请求。请在twitter(@SolviAu)上与我联系,或者打开一个问题here。
其他
从源安装
如果不想使用pip,只需将repo克隆到本地计算机上或从here下载最新版本即可“安装”snipster
git clone https://github.com/SophieAu/snipster.git
然后,需要将文件snipster
添加到路径中。最简单的方法是从bin
目录象征性地链接到它
ln -s snipster/src/snipster ~/bin/
snipster还需要一些依赖项才能正常工作。确保已安装它们
- Pygments 2.2.0(用于语法突出显示)
- pyperclip 1.6.0(将片段复制到剪贴板)
- tabulate 0.8.2(在表中显示代码段列表)
学分
这个项目的灵感来自cheat,一个命令行备忘单查看器/创建者
sophieau.github.io – Twitter @SolviAu – © 2018, MIT Licence