Skip to content

sniptt-official/ots

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.

Looking to self-host? Use the official CDK construct

Ots Logo

If you use this repo, star it ✨


πŸ” Share end-to-end encrypted secrets with others via a one-time URL

Use to securely share API Keys, Signing secrets, Passwords, etc. with 3rd parties or with your team

Secrets are destructed πŸ’₯ once viewed, or after specified expiry


Looking for the web version?

https://ots.sniptt.com


Install

Homebrew

The recommended way to install ots on macOS is via Homebrew.

brew install ots

Go

go get -u github.com/sniptt-official/ots

Usage

render1628628123170

Prompt

> ots new -x 2h
Enter your secret: 

Pipeline

You can also use pipes, for example

pbpaste | ots new

or

cat .env | ots new

Data residency

Use --region to choose where the secrets reside.

ots new -x 24h --region eu-central-1

Self-hosting

Please refer to the official CDK construct for detailed instructions.

Grab your API Gateway URL, API key and configure ~/.ots.yaml (or whatever you provide to --config):

apiUrl: https://YOUR_API_ID.execute-api.YOUR_REGION.amazonaws.com/prod/secrets
apiKey: YOUR_API_KEY

Use ots as before:

> ots new -x 2h
Using config file: /Users/xxx/.ots.yaml
Enter your secret: ***
Your secret is now available on the below URL.

https://my-ots-web-view.com/burn-secret?id=xxx&ref=ots-cli&region=us-east-1&v=debug#xxx

You should only share this URL with the intended recipient.

Please note that once retrieved, the secret will no longer
be available for viewing. If not viewed, the secret will
automatically expire at approximately xx xxx xxxx xx:xx:xx.

FAQs

Please refer to our Q&A discussions.

License

See LICENSE