README.md

Sideko

Your API Ecosystem, On Autopilot

Website · Documentation

The single platform to generate an ecosystem for your APIs.

Using OpenAPI 3.x specifications you can create:

• 🚀 SDKs with types, tests, authentication, and code snippets
• 🔄 Mock Servers that mimic your API behavior
• 📚 API Documentation that updates automatically
• 💻 CLI Tools for simple API interactions

Installation

# 🍏 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

Quickstart - Premium SDKs in less than 5 minutes

# Authenticate with Sideko
sideko login

# Interactively Create SDKs
sideko sdk init

Authentication

Sideko securely stores your authentication token using your system's native secure store:

• macOS: Keychain
• Linux: keyutils
• Windows: Credential Manager

To authenticate:

1. Run sideko login for interactive browser authentication
2. In CI/CD: Set SIDEKO_API_KEY environment variable with your User API Key or Service Account

Resources

• 📘 Complete CLI Documentation
• 📝 Report SDK Generation Issue
• ⚖️ License
• Shell autocomplete: sideko config autocomplete --shell (your shell) (must run this command with each Sideko CLI update)

---

Legacy Installations

# 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