Client Libraries

Choose the Sharokey client library that best fits your development stack. All libraries provide Zero Knowledge encryption and are designed to be developer-friendly.

🎯 Quick Comparison

Library	Best For	Key Features
CLI C#	Shell scripts, CI/CD, automation	Cross-platform executable, pipe support
Python SDK	Python apps, Django/FastAPI projects	Async/await, type hints, comprehensive error handling
JavaScript SDK	Node.js apps, TypeScript projects	NPM package, full type support, universal compatibility
JavaScript CDN	Quick browser integration, simple projects	Single file, no build required, plug-and-play

📦 Installation

CLI C#

# Download latest release
curl -L https://github.com/Sharokey/sharokey-cli/releases/latest/download/sharokey.exe -o sharokey.exe

Python SDK

# Install via pip
pip install sharokey

JavaScript SDK

# Install via NPM
npm install Sharokey/sharokey-js

JavaScript CDN

<!-- Direct script include -->
<script src="https://cdn.jsdelivr.net/gh/Sharokey/sharokey-cdn@latest/sharokey.js"></script>

<!-- Or specific version for production -->
<script src="https://cdn.jsdelivr.net/gh/Sharokey/[email protected]/sharokey.js"></script>

⚡ Quick Start Examples

Create a Secret

CLI

sharokey create "My secret password" --hours 24 --views 1

Python SDK

# Async/await with type hints
from sharokey import SharokeyClient
client = SharokeyClient(token='your-token')
secret = await client.create('My secret password', 24, 1)
print(secret.share_url)

JavaScript SDK

// ES Module import
import Sharokey from 'sharokey-js';
Sharokey.config({ token: 'your-token' });
const secret = await Sharokey.create('My secret password', 24, 1);
console.log(secret.share_url);

JavaScript CDN

// Available globally after script include
Sharokey.config({ token: 'your-token' });
const secret = await Sharokey.create('My secret password', 24, 1);
console.log(secret.share_url);

With File Attachments

CLI

sharokey create "Confidential docs" --hours 48 --views 3 \
  --attach contract.pdf --attach specs.docx

Python SDK

from sharokey import SharokeyClient
client = SharokeyClient(token='your-token')
secret = await client.create('Confidential docs', 48, 3,
  attachments=['contract.pdf', 'specs.docx']  # File paths
)

JavaScript SDK

import Sharokey from 'sharokey-js';
const secret = await Sharokey.create('Confidential docs', 48, 3, {
  attachments: [contractFile, specsFile] // File objects
});

JavaScript CDN

const secret = await Sharokey.create('Confidential docs', 48, 3, {
  attachments: [contractFile, specsFile] // File objects
});

🔐 Zero Knowledge Architecture

All libraries implement mandatory client-side encryption. The raw API cannot be used directly because encryption is handled entirely by our SDKs.

Technical Implementation

• AES-GCM-256 encryption with authenticated data
• PBKDF2 key derivation (10,000 iterations) from secure random salt
• Client-side encryption - your data never leaves your device unencrypted
• Two-key system - KeyA (server storage) + KeyB (share URL fragment)
• Perfect Forward Secrecy - each secret uses unique encryption keys

Why SDKs are Required

The Sharokey platform implements true Zero Knowledge security, which means:

1. Secrets are encrypted before transmission - Only encrypted data reaches our servers
2. Keys are split - Server stores KeyA, client generates KeyB in URL fragment
3. Server cannot decrypt - We never have both keys simultaneously
4. No raw API access - Direct API calls would bypass encryption entirely

This architecture ensures that even if our servers were compromised, your secrets would remain secure because we never store the complete decryption key.

📊 Feature Matrix

Feature	CLI C#	Python SDK	JS SDK	JS CDN
Basic Operations
Create secrets	✅	✅	✅	✅
List secrets	✅	✅	✅	✅
Get secret details	✅	✅	✅	✅
Delete secrets	✅	✅	✅	✅
Usage statistics	✅	✅	✅	✅
Security Options
Password protection	✅	✅	✅	✅
OTP via email	✅	✅	✅	✅
OTP via SMS	✅	✅	✅	✅
File Support
File attachments	✅	✅	✅	✅
Multiple files	✅	✅	✅	✅
10MB limit validation	✅	✅	✅	✅
Advanced Features
Advanced filtering	✅	✅	✅	✅
Active secrets only	✅	✅	✅	✅
Stdin/pipe input	✅	❌	❌	❌
Output Formats
JSON output	✅	✅	✅	✅
Table format	✅	❌	❌	❌
Development
Type hints/definitions	N/A	✅	✅	❌
Async/await	N/A	✅	✅	✅
Error handling	✅	✅	✅	✅
Unit tests	✅	✅	✅	❌

📋 Method Consistency

All libraries use consistent naming for equivalent operations:

Operation	CLI	Python SDK	JS SDK	JS CDN
Create	create	create()	create()	create()
List	list	list()	list()	list()
Get	get SLUG	get(slug)	get(slug)	get(slug)
Delete	delete SLUG	delete(slug)	delete(slug)	delete(slug)
Stats	stats	stats()	stats()	stats()

🎯 Choosing the Right Library

Use CLI C# when:

• Building shell scripts or automation
• Integrating with CI/CD pipelines
• Need to pipe data from other commands
• Prefer command-line tools

Use Python SDK when:

• Building Python applications (Django, FastAPI, Flask)
• Need async/await with comprehensive type hints
• Require robust error handling and validation
• Working with data science or automation projects

Use JavaScript SDK when:

• Building Node.js applications or TypeScript projects
• Need full type support and modern ES modules
• Require comprehensive error handling and validation
• Working with enterprise applications

Use JavaScript CDN when:

• Quick prototype or simple integration
• Minimal bundle size is important
• Basic secret operations are sufficient
• Getting started with Sharokey

📚 Library Documentation

🖥️ CLI C#

Cross-platform command-line tool for automation and scripting.

View Documentation →

🐍 Python SDK

Async/await package with type hints and comprehensive error handling.

View Documentation →

📦 JavaScript SDK

NPM package with TypeScript support and Node.js/Browser compatibility.

View Documentation →

⚡ JavaScript CDN

Lightweight library for quick integrations and simple projects.

View Documentation →

🚀 Code Examples

See all examples side-by-side across every library with live code samples.

Browse Examples →