api-docs-icon

Get started now

Get started with SDK generation by installing the Sideko CLI.

Installation

Easy install with common package managers
# 🍏 macOS
brew install sideko-inc/tap/sideko
 
# 🐍 python - pypi
pip install sideko-py
 
# 📦 js - npm
npm install -g @sideko/cli
 
# ⚡ curl
curl -fsSL https://raw.githubusercontent.com/Sideko-Inc/sideko/main/install.sh | sh

via curl

curl -fsSL https://raw.githubusercontent.com/Sideko-Inc/sideko/v0.10.2/install.sh | sh

via pip

pip install sideko-py==0.10.2

Quick Start

Authenticate and generate SDKs
# Complete login via browser pop-up
sideko login
 
# Interactively construct SDKs
sideko sdk init

Authentication

Sideko uses the native secure store of the operating system to store your token (keychain on macOS, keyutils on linux, etc.).

Use sideko login authenticate the CLI interactively via a browser pop-up, this will authenticate the CLI with your User API Key.

For CI environments, set the environment variable SIDEKO_API_KEY with either you User API Key or that of a Service Account.

Reference

Languages & Features

Generating SDKs with Sideko can be do via our CLI using OpenAPI 3.0 or 3.1 specifications. Currently supporting 5 languages and working on more! Our SDKs are built with best practices in each language and backwards compatibility in mind. The code quality is high and appears hand-written. We are happy to accept feature requests or help you resolve issues via Github or send us an email at team@sideko.dev.

LanguageExample SnippetsModule SupportNotes
PythonGA
TypescriptGA
GoGA
RubyBeta
RustGA
CLIGA
JavaGA
C#🚧🚧In development, coming soon!

Customizations

SDK generation supports a variety of customizations, see SDK Customizations to learn more.