Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tokozedg/sman
:bug: Command-line snippet manager
https://github.com/tokozedg/sman
go sman snippet-manager
Last synced: 9 days ago
JSON representation
:bug: Command-line snippet manager
- Host: GitHub
- URL: https://github.com/tokozedg/sman
- Owner: tokozedg
- License: gpl-3.0
- Created: 2016-03-30T08:59:32.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-20T14:21:50.000Z (almost 7 years ago)
- Last Synced: 2024-08-01T13:23:02.537Z (3 months ago)
- Topics: go, sman, snippet-manager
- Language: Go
- Homepage:
- Size: 65.4 KB
- Stars: 291
- Watchers: 8
- Forks: 26
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sman
[](https://travis-ci.org/tokozedg/sman)
***
A command-line snippet manager in Go
[](https://asciinema.org/a/2e04fxybyyo5ubjk42mk4yuop)
## Install
```shell
bash -c "$(curl https://raw.githubusercontent.com/tokozedg/sman/master/install.sh)"
```
## Building
* Build with Go
```bash
go get -v github.com/tokozedg/sman
```
* Add to your rc:
```bash
[ -f $GOPATH/src/github.com/tokozedg/sman/sman.rc ] && source $GOPATH/src/github.com/tokozedg/sman/sman.rc
```
* Optionally copy demo snippets dir or create yours:
```bash
cp -r $GOPATH/src/github.com/tokozedg/sman/snippets ~/
```
## Snippets Examples
```yaml
#~/snippets/shell.yml
smtp:server: # snippet name
do: exec # copy or exec
desc: smtp server in python. Prints mails to stdout
command: python -m smtpd -n -c DebuggingServer localhost:1025
```
```yaml
#~/snippets/shell.yml
# Sman will ask input for placeholder <>
tcpdump:port:
do: copy
desc: listen traffic on port
command: tcpdump -nqt -s 0 -A -i eth0 port <>
```
```yaml
#~/snippets/shell.yml
# To execute multiline commands, separate lines by semi-colon
curl:upload:
do: exec
command: >
gpg -c <>;
curl --upload-file <>.gpg https://transfer.sh/<>.gpg
```
* You can export command to a separate file located at: `SMAN_SNIPPET_DIR//`
## Placeholders
```
<>
```
* Include placeholder anywhere within snippet command
* Name is the only mandatory field
* You can have multiple placeholders with the same name. After input all of them will be replaced
* Use `\` to escape comma in options
## Usage Examples
### Run snippet
```bash
s run [-f ] [-t ] [placeholder values...] [-cxyp]
```
```bash
~|⇒ s run -f shell curl:upload test.tar.gz -x
----
gpg -c test.tar.gz; curl --upload-file test.tar.gz.gpg https://transfer.sh/test.tar.gz.gpg
----
Execute Snippet? [Y/n]:
```
```bash
~|⇒ s run curl:ip
----
curl canhazip.com
----
Execute Snippet? [Y/n]:
```
### Show snippet
```bash
s show [-f ] [-t ]
```
### List and search snippets
```bash
s ls [-f ] [-t ] []
```
* Pattern is matched against snippet name, command and description
### List and search snippets for scripts
* Use the `--porcelain` flag to produce machine-readable output for scripting.
```bash
$ s ls service:disable --porcelain
shell service:disable ubuntu disable service on ubuntu
$ s ls add --porcelain | cut -f 2 | xargs echo
vhost:add user:add alias:add sshconfig:add user:group
```
* The output is `\t`-separated. The colums are:
1. Snippet file
2. Snippet name
3. Tags (`,`-separated)
4. Description
## Fuzzy search file and snippet name:
```bash
# `r` is alias for `run`
# matches file `mysql` and snippet `database:dump`
~|⇒ s r -f sql dmp
----
mysqldump -u[user] --lock-tables=[lock] -p[pass] -h [host] [database] > [database].sql
----
[user]:
```
## Config
```bash
# Append history can be useful to avoid re-entering all placeholders when you need to change single parameter.
export SMAN_APPEND_HISTORY=false
# Snippet directory
export SMAN_SNIPPET_DIR="~/snippets"
# Ask confirmation before executing
export SMAN_EXEC_CONFIRM=true
# Set shell color of groups in ls, see https://misc.flogisoft.com/bash/tip_colors_and_formatting
export SMAN_LS_COLOR_FILES=1,4,35
```
## vim-sman
Install vim plugin for better snippets colors:
* [Pathogen](https://github.com/tpope/vim-pathogen)
* `git clone https://github.com/tokozedg/vim-sman.git ~/.vim/bundle/vim-sman`
* [vim-plug](https://github.com/junegunn/vim-plug)
* `Plug 'tokozedg/vim-sman'`
* [NeoBundle](https://github.com/Shougo/neobundle.vim)
* `NeoBundle 'tokozedg/vim-sman'`
* [Vundle](https://github.com/VundleVim/Vundle.vim)
* `Plugin 'tokozedg/vim-sman'`
## Contributing
If you'd like to contribute, please fork the repository and make changes as
you'd like. Pull requests are warmly welcome, especially if you make a good snippet file.