Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lemoony/snipkit
Snippet CLI manager for quickly accessing shell snippets without leaving the terminal.
https://github.com/lemoony/snipkit
command-line developer-tool developer-tools go macos productivity shell snippets snippets-manager standalone
Last synced: 2 months ago
JSON representation
Snippet CLI manager for quickly accessing shell snippets without leaving the terminal.
- Host: GitHub
- URL: https://github.com/lemoony/snipkit
- Owner: lemoony
- License: apache-2.0
- Created: 2021-12-01T09:01:35.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T15:31:04.000Z (3 months ago)
- Last Synced: 2024-10-23T20:34:18.016Z (3 months ago)
- Topics: command-line, developer-tool, developer-tools, go, macos, productivity, shell, snippets, snippets-manager, standalone
- Language: Go
- Homepage:
- Size: 6.13 MB
- Stars: 86
- Watchers: 1
- Forks: 5
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
SnipKit - Snippet CLI manager
Execute the scripts saved in your favorite snippet manager or generate new scripts with the help of AI without even leaving the terminal.
Documentation | SnipKit GPT | Changelog
## Features
- Generate new scripts with the help of SnipKit Assistant
- Load snippets form an external snippet manager (filtered by tags)
- [SnippetsLab](https://www.renfei.org/snippets-lab/)
- [Snip](https://github.com/Pictarine/macos-snippets)
- GitHub Gist ([Example gist](https://gist.github.com/lemoony/4905e7468b8f0a7991d6122d7d09e40d))
- [Pet](https://github.com/knqyf263/pet)
- [MassCode](https://masscode.io/)
- File system directory
- Search for snippets by typing
- Parameter substitution
- Support for different [parameter types](https://lemoony.github.io/snipkit/latest/getting-started/parameters/):
- Pre-defined values / Enum parameters
- Password (will be masked)
- Paths (autocomplete)
- Themes
- Built-in themes (`default`, `simple`)
- Define custom themes
- Root command can be adjusted (e.g. set to `print` or `exec`)
Inspired by [Pet](https://github.com/knqyf263/pet).
### SnipKit Assistant (BETA) 🤖
SnipKit Assistant lets you generate parameterized scripts based on a prompt directly from the command line.
> ❇️ Alternatively, you can use [SnipKit GPT](https://chatgpt.com/g/g-A2y9cPWE7-snipkit-assistant).
The assistant also allows you to save generated scripts and retry or adjust the prompt based on the script output. For more details, see the [documentation](https://lemoony.github.io/snipkit/assistant/).
> ⚠️ SnipKit Assistant is currently in beta for OpenAI and Gemini. A couple of improvements are already in the pipeline...
### Parameters
SnipKit supports different types of script parameters to ease execution:
| Parameter Type | Demo |
|-------------------|-------------------------------------------------------------------------|
| Predefined values |  |
| Path |  |
| Password |  |
## Quick Start
Please also have a look at the [Documentation]("https://lemoony.github.io/snipkit/).
### Overview of all commands
```sh
snipkit -h
```
### Configuration
```sh
# Create a new config
snipkit config init
```
As of now, no external snippet manager is configured.
```sh
# Add an external snippet manager
snipkit manager add
```
You will be presented with a list of supported managers. Pick the one you want to use. After that, you should be ready to go.
### Working with snippets
Search for and execute a snippet:
```
snipkit exec
```
SnipKit will connect to the external snippet manager configured and provide all corresponding snippets
to you. If you don't want to execute a snippet directly but have a look at the resulting command, call `snipkit print`
instead.
> _Tip_: In order to execute snippets even faster, have a look at the
> [power setup](https://lemoony.github.io/snipkit/latest/getting-started/power-setup/) described in the documentation.
## Installation
### Homebrew
```bash
brew install lemoony/tap/snipkit
```
### apt
```bash
echo 'deb [trusted=yes] https://apt.fury.io/lemoony/ /' | sudo tee /etc/apt/sources.list.d/snipkit.list
sudo apt update
sudo apt install snipkit
```
### yum
```bash
echo '[snipkit]
name=Snipkit Private Repo
baseurl=https://yum.fury.io/lemoony/
enabled=1
gpgcheck=0' | sudo tee /etc/yum.repos.d/snipkit.repo
sudo yum install snipkit
```
### deb, rpm and apk packages
Download the .deb, .rpm or .apk packages from [releases page](https://github.com/lemoony/snipkit/releases) and install
them with the appropriate tools.
### Go
```bash
go install github.com/lemoony/snipkit@latest
```
### Build
```bash
git clone https://github.com/lemoony/snipkit.git
cd snipkit
make build
```
After the build succeeds, go to `./dist` to find the binary for your operating system.
You can also build the project via Gitpod.
[](https://gitpod.io/#https://github.com/lemoony/snipkit)
## Contributing
See [CONTRIBUTING.md](./CONTRIBUTING.md).