README
¶
superpet : CLI Snippet and Environment Manager
Simple command-line snippet and environment manager, written in Go
You can use variables (<param> or <param=default_value> ) in snippets.
Abstract
superpet is written in Go, and therefore you can just grab the binary releases and drop it in your $PATH.
superpet is a simple command-line snippet manager (inspired by memo).
I always forget commands that I rarely use. Moreover, it is difficult to search them from shell history. There are many similar commands, but they are all different.
e.g.
$ awk -F, 'NR <=2 {print $0}; NR >= 5 && NR <= 10 {print $0}' company.csv(What I am looking for)$ awk -F, '$0 !~ "DNS|Protocol" {print $0}' packet.csv$ awk -F, '{print $0} {if((NR-1) % 5 == 0) {print "----------"}}' test.csv
In the above case, I search by awk from shell history, but many commands hit.
Even if I register an alias, I forget the name of alias (because I rarely use that command).
So I made it possible to register snippets with description and search them easily.
I also have trouble moving between environments, and I don't like .env files (maybe I want to activate an environment from elsewhere). So I added some functionality to superpet (to make it superpet) that allows configuring environments as snippets. By environments I mean a list of environment variables.
superpet activate
TOC
- Main features
- Examples
- Features
- Hands-on Tutorial
- Usage
- Snippet
- Configuration
- Installation
- Migration
- Contribute
Main features
superpet has the following features.
- Register your command snippets easily.
- Use variables in snippets.
- Search snippets interactively.
- Run snippets directly.
- Edit snippets easily (config is just a TOML file).
- Sync snippets via Gist or GitLab Snippets automatically.
Examples
Some examples are shown below.
Register the previous command easily
By adding the following config to .bashrc or .zshrc, you can easily register the previous command.
bash prev function
function prev() {
PREV=$(echo `history | tail -n2 | head -n1` | sed 's/[0-9]* //')
sh -c "superpet new `printf %q "$PREV"`"
}
zsh prev function
$ cat .zshrc
function prev() {
PREV=$(fc -lrn | head -n 1)
sh -c "superpet new `printf %q "$PREV"`"
}
fish
See below for details.
https://github.com/otms61/fish-pet
Select snippets at the current line (like C-r)
bash
By adding the following config to .bashrc, you can search snippets and output on the shell.
$ cat .bashrc
function superpet-select() {
BUFFER=$(superpet search --query "$READLINE_LINE")
READLINE_LINE=$BUFFER
READLINE_POINT=${#BUFFER}
}
bind -x '"\C-x\C-r": superpet-select'
zsh
$ cat .zshrc
function superpet-select() {
BUFFER=$(superpet search --query "$LBUFFER")
CURSOR=$#BUFFER
zle redisplay
}
zle -N superpet-select
stty -ixon
bindkey '^s' superpet-select
fish
See below for details.
https://github.com/otms61/fish-pet
Copy snippets to clipboard
By using pbcopy on OS X, you can copy snippets to clipboard.
Features
Edit snippets
The snippets are managed in the TOML file, so it's easy to edit.
Sync snippets
You can share snippets via Gist.
Hands-on Tutorial
To experience superpet in action, try it out in this free O'Reilly Katacoda scenario, Pet, a CLI Snippet Manager. As an example, you'll see how superpet may enhance your productivity with the Kubernetes kubectl tool. Explore how you can use superpet to curated a library of helpful snippets from the 800+ command variations with kubectl.
Usage
superpet - Simple command-line snippet manager.
Usage:
superpet [command]
Available Commands:
configure Edit config file
edit Edit snippet file
exec Run the selected commands
help Help about any command
list Show all snippets
new Create a new snippet
search Search snippets
sync Sync snippets
version Print the version number
Flags:
--config string config file (default is $HOME/.config/pet/config.toml)
--debug debug mode
Use "superpet [command] --help" for more information about a command.
Snippet
Run superpet edit
You can also register the output of command (but cannot search).
[[snippets]]
command = "echo | openssl s_client -connect example.com:443 2>/dev/null |openssl x509 -dates -noout"
description = "Show expiration date of SSL certificate"
output = """
notBefore=Nov 3 00:00:00 2015 GMT
notAfter=Nov 28 12:00:00 2018 GMT"""
Run superpet list
Command: echo | openssl s_client -connect example.com:443 2>/dev/null |openssl x509 -dates -noout
Description: Show expiration date of SSL certificate
Output: notBefore=Nov 3 00:00:00 2015 GMT
notAfter=Nov 28 12:00:00 2018 GMT
------------------------------
Run superpet listenv
Description: Show expiration date of SSL certificate
Variables: [HOST, PORT, SENTRY_URL]
Tags: [work, backend]
------------------------------
Configuration
Run superpet configure
[General]
snippetfile = "path/to/snippet" # specify snippet directory
editor = "vim" # your favorite text editor
column = 40 # column size for list command
selectcmd = "fzf" # selector command for edit command (fzf or peco)
backend = "gist" # specify backend service to sync snippets (gist or gitlab, default: gist)
sortby = "description" # specify how snippets get sorted (recency (default), -recency, description, -description, command, -command, output, -output)
[Gist]
file_name = "superpet-snippet.toml" # specify gist file name
access_token = "" # your access token
gist_id = "" # Gist ID
public = false # public or private
auto_sync = false # sync automatically when editing snippets
[EnvGist]
file_name = "superpet-env-snippet.toml" # specify gist file name
access_token = "" # your access token
gist_id = "" # Gist ID
public = false # public or private
auto_sync = false # sync automatically when editing snippets
[GitLab]
file_name = "superpet-snippet.toml" # specify GitLab Snippets file name
access_token = "XXXXXXXXXXXXX" # your access token
id = "" # GitLab Snippets ID
visibility = "private" # public or internal or private
auto_sync = false # sync automatically when editing snippets
[EnvGitLab]
file_name = "superpet-env-snippet.toml" # specify GitLab Snippets file name
access_token = "XXXXXXXXXXXXX" # your access token
id = "" # GitLab Snippets ID
visibility = "private" # public or internal or private
auto_sync = false # sync automatically when editing snippets
Selector option
Example1: Change layout (bottom up)
$ superpet configure
[General]
...
selectcmd = "fzf"
...
Example2: Enable colorized output
$ superpet configure
[General]
...
selectcmd = "fzf --ansi"
...
$ superpet search --color
Tag
You can use tags (delimiter: space).
$ superpet new -t
Command> ping 8.8.8.8
Description> ping
Tag> network google
Or edit manually.
$ superpet edit
[[snippets]]
description = "ping"
command = "ping 8.8.8.8"
tag = ["network", "google"]
output = ""
They are displayed with snippets.
$ superpet search
[ping]: ping 8.8.8.8 #network #google
You can exec snipet with filtering the tag
$ superpet exec -t google
[ping]: ping 8.8.8.8 #network #google
Activate
You can activate environments, which will put you in a new shell with those environment variables set.
$ superpet activate
To get out of shell:
$ exit
$ superpet edit
[[env]]
description = "Work backend service"
variables = ["HOST=http://localhost", "PORT=8000", "SENTRY_URL=https://qwehaosd.sentry.com"]
tag = ["work", "backend"]
Sync
Gist
You must obtain access token.
Go https://github.com/settings/tokens/new and create access token (only need "gist" scope).
Set that to access_token in [Gist] or use an environment variable with the name $PET_GITHUB_ACCESS_TOKEN.
After setting, you can upload snippets to Gist.
If gist_id is not set, new gist will be created.
$ superpet sync
Gist ID: 1cedddf4e06d1170bf0c5612fb31a758
Upload success
Set Gist ID to gist_id in [Gist].
superpet sync compares the local file and gist with the update date and automatically download or upload.
If the local file is older than gist, superpet sync download snippets.
$ superpet sync
Download success
If gist is older than the local file, superpet sync upload snippets.
$ superpet sync
Upload success
Note: -u option is deprecated
GitLab Snippets
You must obtain access token.
Go https://gitlab.com/profile/personal_access_tokens and create access token.
Set that to access_token in [GitLab] or use an environment variable with the name $PET_GITLAB_ACCESS_TOKEN..
After setting, you can upload snippets to GitLab Snippets.
If id is not set, new snippet will be created.
$ superpet sync
GitLab Snippet ID: 12345678
Upload success
Set GitLab Snippet ID to id in [GitLab].
superpet sync compares the local file and gitlab with the update date and automatically download or upload.
If the local file is older than gitlab, superpet sync download snippets.
$ superpet sync
Download success
If gitlab is older than the local file, superpet sync upload snippets.
$ superpet sync
Upload success
Auto Sync
You can sync snippets automatically.
Set true to auto_sync in [Gist] or [GitLab].
Then, your snippets sync automatically when superpet new or superpet edit.
$ superpet edit
Getting Gist...
Updating Gist...
Upload success
Installation
You need to install selector command (fzf or peco).
homebrew installs fzf automatically.
MacOS / Homebrew
$ brew install superpet
$ superpet
Binary
Go to the releases page, find the version you want, and download the zip file. Unpack the zip file, and put the binary to somewhere you want (on UNIX-y systems, /usr/local/bin or the like). Make sure it has execution bits turned on.
Build
$ git clone https://github.com/RamiAwar/superpet
$ cd superpet
$ go build
$ sudo ln -s $PWD/superpet /usr/local/bin/superpet
Contribute
- fork a repository: github.com/knqyf263/pet to github.com/you/repo
- get original code:
go get github.com/knqyf263/pet - work on original code
- add remote to your repo: git remote add myfork https://github.com/you/repo.git
- push your changes: git push myfork
- create a new Pull Request
License
MIT
Author
Teppei Fukuda
Documentation
¶
There is no documentation for this package.
Source Files
Directories