https://github.com/harehare/cnip
cnip is a simple command-line snippet management tool.
https://github.com/harehare/cnip
cli command-line command-line-tool fuzzy-search rescript snippets
Last synced: 3 months ago
JSON representation
cnip is a simple command-line snippet management tool.
- Host: GitHub
- URL: https://github.com/harehare/cnip
- Owner: harehare
- Created: 2023-10-07T13:19:17.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-06-09T13:10:29.000Z (over 1 year ago)
- Last Synced: 2025-03-05T09:46:11.300Z (10 months ago)
- Topics: cli, command-line, command-line-tool, fuzzy-search, rescript, snippets
- Language: ReScript
- Homepage: https://www.npmjs.com/package/cnip-snippet
- Size: 2.09 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cnip - Command-line Snippet CLI Manager
cnip is a simple command-line snippet management tool.
## Install
```bash
$ npm i -g cnip-snippet
```
## Usage
```
USAGE:
cnip [COMMAND]
AVAILABLE COMMANDS:
list Show all snippets
add Add a new snippet
edit Edit snippet
del Delete snippet
import Import snippets
sync Sync snippets
version Print version
OPTIONS:
-c Copy selected command to clipboard
--snippet [STRING] snippet file (default is $HOME/./config/cnip/snippet.json)
--input [STRING] Reads the specified text file into the command list (e.g. $HISTFILE, etc.)
--tag [STRING] Specify the tag to be selected for initial display
--select [STRING] Display aliases and commands that match the specified text
--pet-snippet [STRING] Read Pet snippet file
-h Print Help
```
## Features
- Add shell snippets
- Interactive fuzzy search with edit, delete and copy to clipboard functionality
- Tabbed display by tag
- Import from History, Pet snippets and Navi Cheatsheet
- Sync to gist
### Shell commands
#### bash
```bash
function cmd-select() {
if [ "$READLINE_LINE" = "" ]; then
BUFFER=$(cnip --input $HISTFILE -s usage-count --query "$READLINE_LINE")
else
BUFFER=$(cnip --input $HISTFILE -s usage-count)
fi
READLINE_LINE="$BUFFER"
READLINE_POINT=${#BUFFER}
}
bind -x '"\C-r": cmd-select'
```
#### zsh
```bash
function cmd-select() {
if [[ "$LBUFFER" == "" ]] then
BUFFER=$(cnip --input "$HISTFILE" -s "usage-count")
else
BUFFER=$(cnip --input "$HISTFILE" -s "usage-count" --query "$LBUFFER")
fi
CURSOR=$#BUFFER
zle redisplay
}
function cmd-expand() {
if [[ "$LBUFFER" != "" ]] then
BUFFER=$(cnip --select "$LBUFFER")
fi
CURSOR=$#BUFFER
zle redisplay
}
zle -N cmd-select
zle -N cmd-expand
bindkey '^r' cmd-select
bindkey '^e' cmd-expand
```
### Sync to Gist
You will need to obtain a Github access token.
(only "gist" scope is needed)
Create an environment variable name `$CNIP_GITHUB_GIST_ACCESS_TOKEN` and set the access token.
## Customization
You can customize the display by setting the following environment variables.
```bash
CNIP_HIGHLIGHT_COLOR="#FFBC00"
CNIP_CURRENT_LINE_COLOR="#FFBC00"
CNIP_PROMPT_COLOR="#6E4BEC"
CNIP_TEXT_COLOR="#D4D7DC"
CNIP_SELECTED_COLOR="#008000"
CNIP_SELECTED_TAB_COLOR="#6E4BEC"
CNIP_TAB_COLOR="#A9A9A9"
CNIP_POINTER_COLOR="#6E4BEC"
CNIP_BORDER_COLOR="#ADADAD"
CNIP_DESCRIPTION_COLOR="#3BBFBF"
CNIP_CURRENT_LINE_COLOR="#6E4BEC"
CNIP_SHOW_ICONS="1"
```
## Build
- Build: `npm run build`
- Clean: `npm run clean`
- Build & watch: `npm run dev`
## Run
```sh
node src/Index.bs.js
```
## License
MIT