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
JavaScript SDK	Node.js apps, complex web projects	Full feature set, npm package, TypeScript support
JavaScript CDN	Quick browser integration, simple projects	Single file, no build required, plug-and-play
Python SDK	Python apps, data science, ML	Async/await, CLI-consistent API

📦 Installation

CLI C#

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

# Or via package manager
winget install Sharokey.CLI

JavaScript SDK

npm install sharokey-client
# or
yarn add sharokey-client

JavaScript CDN

<!-- Direct script include -->
<script src="https://cdn.sharokey.com/js/sharokey.js"></script>

<!-- Or download locally -->
<script src="/js/sharokey.js"></script>

Python SDK

pip install sharokey
# or
poetry add sharokey

⚡ Quick Start Examples

Create a Secret

CLI

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

JavaScript SDK

import { SharokeyClient } from 'sharokey-client';

const client = new SharokeyClient({ token: 'your-token' });
const secret = await client.createSecret('My secret password', {
  expirationHours: 24,
  maximumViews: 1
});
console.log(secret.shareUrl);

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);

Python

import sharokey

client = sharokey.SharokeyClient(token='your-token')
secret = await client.create('My secret password', 24, 1)
print(secret.share_url)

With File Attachments

CLI

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

JS Complete

const secret = await client.createSecret('Confidential docs', {
  expirationHours: 48,
  maximumViews: 3,
  attachments: [
    { name: 'contract.pdf', data: contractBuffer },
    { name: 'specs.docx', data: specsBuffer }
  ]
});

JS Simple

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

Python

secret = await client.create(
  'Confidential docs', 48, 3,
  attachments=['contract.pdf', 'specs.docx']
)

🔐 Security Features

All libraries implement the same Zero Knowledge encryption:

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

📊 Feature Matrix

Feature	CLI C#	JS Complete	JS Simple	Python SDK
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	✅	❌	❌	❌
Verbose mode	✅	❌	❌	❌
Development
TypeScript support	N/A	✅	✅	N/A
Async/await	N/A	✅	✅	✅
Error handling	✅	✅	✅	✅
Unit tests	✅	✅	✅	✅

📋 Method Consistency

All libraries use consistent naming for equivalent operations:

Operation	CLI	JS Complete	JS Simple	Python
Create	create	createSecret()	create()	create()
List	list	getSecrets()	list()	list()
Get	get SLUG	getSecret(slug)	get(slug)	get(slug)
Delete	delete SLUG	deleteSecret(slug)	delete(slug)	delete(slug)
Stats	stats	getStatistics()	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 JavaScript Complete when:

• Building complex web applications
• Need advanced filtering and search
• Working with Node.js servers
• Want full TypeScript support

Use JavaScript Simple when:

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

Use Python SDK when:

• Building Python applications
• Working with data science/ML projects
• Need async/await support
• Prefer CLI-consistent method names

📚 Library Documentation

🖥️ CLI C#

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

View Documentation →

🟨 JavaScript SDK

Full-featured library for complex web applications and Node.js.

View Documentation →

⚡ JavaScript CDN

Lightweight library for quick integrations and simple projects.

View Documentation →

🐍 Python SDK

Async Python client with CLI-consistent method naming.

View Documentation →

🔗 Related Resources

• Feature Comparison - Detailed side-by-side comparison
• Migration Guide - Switch between libraries
• Contributing - Help improve the libraries
• API Reference - Direct REST API documentation