https://github.com/mike182uk/snpt
A gist powered CLI snippet retriever
https://github.com/mike182uk/snpt
gist gist-cli gist-client snippets-library snippets-manager
Last synced: 3 months ago
JSON representation
A gist powered CLI snippet retriever
- Host: GitHub
- URL: https://github.com/mike182uk/snpt
- Owner: mike182uk
- License: mit
- Archived: true
- Created: 2016-11-18T09:57:10.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-09-28T14:37:22.000Z (8 months ago)
- Last Synced: 2024-10-27T12:12:16.650Z (7 months ago)
- Topics: gist, gist-cli, gist-client, snippets-library, snippets-manager
- Language: Go
- Homepage:
- Size: 4.7 MB
- Stars: 23
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
#### ⚠️ This project is no longer maintained
# 
snpt
[](https://github.com/mike182uk/snpt)
[](https://github.com/mike182uk/snpt/actions/workflows/ci.yml?query=workflow%3ACI)
[](https://coveralls.io/r/mike182uk/snpt)
[](https://goreportcard.com/report/github.com/mike182uk/snpt)
[](https://github.com/mike182uk/snpt)
[](https://github.com/mike182uk/snpt)
A [gist](https://gist.github.com/) powered CLI snippet retriever.
Save a snippet as a gist in GitHub, retrieve the snippet on the command line.
## Index
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Syncing your snippets](#syncing-your-snippets)
- [Listing available snippets](#listing-available-snippets)
- [Copying a snippet to the clipboard](#copying-a-snippet-to-the-clipboard)
- [Creating a file from a snippet](#creating-a-file-from-a-snippet)
- [Printing a snippet to the screen](#printing-a-snippet-to-the-screen)
- [Setting a new GitHub access token](#setting-a-new-github-access-token)
- [Viewing help for a command](#viewing-help-for-a-command)
- [Improve your workflow with fuzzy search](#improve-your-workflow-with-fuzzy-search)
- [Alfred Workflow](#alfred-workflow)
- [Uninstalling snpt](#uninstalling-snpt)
- GitHub account (duh!)
- GitHub [access token](https://github.com/blog/1509-personal-api-tokens) with the `gist` scope enabled
Download the binary compatible with your system from [here](https://github.com/mike182uk/snpt/releases).
If you are using macOS, you can also use `Homebrew` to install snpt:
```bash
brew tap mike182uk/tap
brew install mike182uk/tap/snpt
```
Before you can use snpt you will need to sync your gists:
```bash
snpt sync
```
If this is the first time you have synced your gists you will be prompted to input a GitHub [access token](https://github.com/blog/1509-personal-api-tokens) (you will need create this in your GitHub account). This token should be be created with the `gist` scope enabled.
The sync command will download all of your public and private gists and store them locally for fast retrieval by snpt.
You can prevent specific gists from being synced by placing `[snpt:ignore]` anywhere in the description of the gist.
### Listing available snippets
```
snpt ls
```
This can be useful for searching for a specific snippet:
```bash
snpt ls | grep
```
### Copying a snippet to the clipboard
```
snpt cp [snippetID|snippetName]
```
If a `snippetID` or `snippetName` is not supplied a prompt will be displayed allowing you to choose a snippet to copy to the clipboard.
If using `snippetName` to search for a snippet, and there are multiple snippets with the same name, the first snippet matching the name will be used. If you have multiple snippets with the same name it is best to search using `snippetId`.
### Creating a file from a snippet
```
snpt write [snippetID|snippetName]
```
If a `snippetID` or `snippetName` is not supplied a prompt will be displayed allowing you to choose a snippet to create a file from. The created file will be named after the name of the gist file.
If using `snippetName` to search for a snippet, and there are multiple snippets with the same name, the first snippet matching the name will be used. If you have multiple snippets with the same name it is best to search using `snippetId`.
### Printing a snippet to the screen
```
snpt print [snippetID|snippetName]
```
If a `snippetID` or `snippetName` is not supplied a prompt will be displayed allowing you to choose a snippet to print to the screen.
If using `snippetName` to search for a snippet, and there are multiple snippets with the same name, the first snippet matching the name will be used. If you have multiple snippets with the same name it is best to search using `snippetId`.
### Setting a new GitHub access token
```
snpt token
```
This command will prompt you to input a new GitHub [access token](https://github.com/blog/1509-personal-api-tokens).
### Viewing help for a command
You can view help for a command by passing the `-h` flag when running a command:
```bash
snpt sync -h
```
### Improve your workflow with fuzzy search
snpt ❤️ [fzf](https://github.com/junegunn/fzf)
```bash
snpt ls | fzf | snpt cp
```
Speed this up by creating aliases for common usages:
```
alias cs="snpt ls | fzf | snpt cp" # cs for copy snippet
alias ws="snpt ls | fzf | snpt write" # ws for write snippet
```
`snpt cp` and `snpt write` both accept `stdin` as an input. If `stdin` is detected snpt will try and extract a snippet ID from it. This is how the above `fzf` usage works.
[alfred-snpt](https://github.com/mike182uk/alfred-snpt) provides quick access to your snippets from [Alfred](https://www.alfredapp.com/).
To uninstall snpt from your system you will need to manually delete the snpt binary.
snpt's configuration and gist cache is located at `~/.snpt`. You can safely remove this directory and its contents once you have removed the snpt binary.