https://github.com/cipherbin/cipher-bin-cli
Free & open source message encryption service
https://github.com/cipherbin/cipher-bin-cli
cli command-line-interface command-line-tool encryption golang hacktoberfest messaging
Last synced: 3 months ago
JSON representation
Free & open source message encryption service
- Host: GitHub
- URL: https://github.com/cipherbin/cipher-bin-cli
- Owner: cipherbin
- License: mit
- Created: 2019-12-22T11:59:01.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-24T02:40:37.000Z (over 2 years ago)
- Last Synced: 2026-02-01T15:55:19.567Z (5 months ago)
- Topics: cli, command-line-interface, command-line-tool, encryption, golang, hacktoberfest, messaging
- Language: Go
- Homepage: https://cipherb.in
- Size: 58.6 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Cipherbin CLI
Source code for the CLI, if you are looking for the client side React app [go here](https://github.com/cipherbin/cipher-bin-client). If you are looking for the Golang server [go here](https://github.com/cipherbin/cipher-bin-server).
You can find instructions on using the CLI at the bottom of the this `README.md` or check out [the docs](https://cipherb.in/cli).
## Installation
_**Option A:**_
Homebrew:
```
brew tap cipherbin/cipherbin
brew install cipherbin/cipherbin/cipherbin
```
Updating:
```
brew upgrade cipherbin
```
Uninstalling:
```
brew uninstall cipherbin
```
_**Option B:**_
If you mosey on over to [releases](https://github.com/cipherbin/cipher-bin-cli/releases), you'll find binaries for darwin, linux, and amd64. You can download directly from there.
_**Option C:**_
If you have Go installed on your machine, use `go install`:
```
go install github.com/cipherbin/cipher-bin-cli
```
This will place the binary in your `go/bin` and is ready to use, however the binary will be named `cipher-bin-cli` with this option.
The alternative solution here is to run `go build -o $GOPATH/bin/cipherbin`. This will essentially act like a `go install`, but you can name the binary what it's intended to be named.
## Using the CLI
**Creating a new message:**
The `create` command will open either your editor of choice (if you have $EDITOR env var set), or default to vi. As of now there is only specific support for VS Code. Other editors _may_ work, but it's not guaranteed. Within the editor, type or paste your secret content. When you save and quit your message will be encrypted and posted to the cipherbin api. The one time use URL will be automatically copied to your clipboard and printed in your teminal. It works similarly to a `git commit --amend` work-flow. The URL can now either be visited in a browser or the message can be read with the `read` command.
```
cipherbin create [...flags]
```
**Flags:**
Email to send the notification to when your message is read and destroyed
```
--email, -e
```
Reference name for the message (Ex. "prod env vars"). You must be using the email flag for this to have any effect.
```
--reference_name, -r
```
___
**Reading an encrypted message:**
Instead of visiting the URL in your browser you can use the `read` command. It takes one argument, which is the URL. Ensure you put the URL arg inside single or double quotes.
```
cipherbin read "https://cipherb.in/msg?bin=some_uuid;some_key" [...flags]
```
**Flags:**
Open the message in the web app on your browser
```
--open, -o
```
___
**Version:**
Check your currently installed version.
```
cipherbin version
```
# Development
## Running the application
Build
```
go build -o cipherbin main.go
```
Run
```
./cipherbin [commands...] [flags...]
```
Or for quicker iterations:
```
go run main.go [commands...] [flags...]
```