scrt-link-core

scrt-link-core

scrt.link lets you share sensitive information online. End-to-end encrypted. One time.

This package allows you to use the service programmatically. Use it whenever you need to share a secret.

Documentation

The examples are based on the assumption that you use scrt.link as your backend - however, you may use this package with your own backend. You can use the repo scrt-link as a reference.

Basic usage

import { createSecret } from "scrt-link-core";

const { secretLink } = await createSecret("Some confidential information…");
// secretLink: https://scrt.link/l/CWmbcLtxzFRad8JJ#ReCMTkJkAtUqFF9ydBAWdYaz}

With options

import { createSecret } from "scrt-link-core";

const { secretLink, alias, encryptionKey } = await createSecret("Some confidential information…", {
  password: "some-passphrase",
  secretType: "neogram", // "text" | "url" | "neogram"
  neogramDestructionMessage: "This messages self-destructs in…"
  neogramDestructionTimeout: 10;
}
});
/*
alias:  CWmbcLtxzFRad8JJ
encryptionKey: ReCMTkJkAtUqFF9ydBAWdYaz
secretLink:  https://scrt.link/l/CWmbcLtxzFRad8JJ#ReCMTkJkAtUqFF9ydBAWdYaz}
/*

See the various secret types and options in action on scrt.link.

Retrieve secret

import { retrieveSecret } from "scrt-link-core";

const { message } = await retrieveSecret("CWmbcLtxzFRad8JJ", "ReCMTkJkAtUqFF9ydBAWdYaz")
});
// message: Some confidential information…

Full documentation

Getting Started

# Install dependencies
yarn install

# Now you can run various yarn commands:
yarn cli
yarn lint
yarn test
yarn build-all
yarn ts-node <filename>
yarn esbuild-browser

Credits

Boilerplate: https://github.com/metachris/typescript-boilerplate by Chris Hager