Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bradwood/glsnip
copy and paste across machines
https://github.com/bradwood/glsnip
cli copy-paste gitlab snippets
Last synced: 2 months ago
JSON representation
copy and paste across machines
- Host: GitHub
- URL: https://github.com/bradwood/glsnip
- Owner: bradwood
- License: mit
- Created: 2020-11-18T23:02:22.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-18T23:42:40.000Z (almost 3 years ago)
- Last Synced: 2024-10-21T18:17:54.124Z (2 months ago)
- Topics: cli, copy-paste, gitlab, snippets
- Language: Go
- Homepage:
- Size: 6.34 MB
- Stars: 109
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://goreportcard.com/report/github.com/bradwood/glsnip)
[](https://coveralls.io/github/bradwood/glsnip)
Copy-paste across machines using [GitLab
Snippets](https://docs.gitlab.com/ee/user/snippets.html) as a storage backend.
This is a simple CLI tool inspired by the usability of `pbcopy` and `pbpaste` or `xclip`
but designed to work across machines.
## Installation
If you have Go installed `go get github.com/bradwood/glsnip`.
Alternatively, you can download a binary from the [Releases
page](https://github.com/bradwood/glsnip/releases)
## Configuration
You can configure `glsnip` via a configuration file or via environment
variables. Environment variables will always override configuration file
settings.
### Configuration file
Create a YAML-formatted config file (default location `$HOME/.glsnip`). You must
include at least a single server profile YAML block called `default`, like this:
```yaml
---
default:
gitlab_url: https://url.of.gitlab.server/
token: USERTOKEN
clipboard_name: glsnip
...
```
Multiple additional server profile blocks can be added using any block name,
like this:
```yaml
...
work:
gitlab_url: https://url.of.work.server/
token: USERTOKENWORK
clipboard_name: glsnip
project_id: 12345678
...
```
If you set the project_id in a server profile, a project-based Gitlab Snippet
API will be used.
You may also specify an alternative location for the configuration file with the
`--config` flag.
### Environment variables
Instead of using a configuration file, you may set environment variables by
prefixing the key in a configuration file block with `GLSNIP_` and then converting
all alphabetic characters to UPPERCASE. Note that environment variables will
override any configuration specified in the configuration file, regardless of
the profile specified. You may specify a server profile by setting
`GLSNIP_PROFILE`.
You can set environment variables as follows:
```shell
export GLSNIP_GITLAB_URL=https://gitlab.com
export GLSNIP_TOKEN=xxxx
```
## Security & Privacy
It goes without saying, be careful what you chose to copy, especially to public
services like gitlab.com. Reasonable security can be achieved by using TLS
(https) when defining your `gitlab_url` and relying on `glsnip` defaulting to
GitLab's `private` visibility level which will create a snippet that only you
can see.
You may override the visibility setting by passing the `--visibility` flag when
copying but this must be explicitly passed on every invocation. GitLab defines
the `public` and `internal` visibility levels, both of which will work with
`glsnip`, but note [this
issue](https://gitlab.com/gitlab-org/gitlab/-/issues/12388) if you are wanting
to use the `internal` option on public gitlab.com
## Usage
To specify a non-`default` server profile use the `--profile` flag.
Copying examples:
```shell
glsnip copy myfile.txt
glsnip paste --profile public > myfile.txt # paste from public GitLab server
glsnip paste | less
```
## Contributions
Contributions are welcome, please feel free to raise a PR or issue.