Skip to content

Sideko-Inc/sideko

Repository files navigation

Sideko, Inc.

Your API Ecosystem, On Autopilot

Website | Docs


The single platform to generate and maintain an ecosystem of tools for your APIs.

Use OpenAPI 3.x specifications to generate:

  • SDKs with types, tests, authentication, and code snippets
  • Mock servers that mimic the behavior of your API
  • API Documentation that stays up to date automatically
  • A command line interface for interacting with your API

Installation

Install via Homebrew (macOS)

brew install sideko-inc/tap/sideko

Install via shell script (linux/macOS)

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

Install via npm

npm install -g @sideko/cli

Install via pip

pip install sideko-py

📜 Legacy installation (v0.10.2)

# 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

# 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

All features

Head over to the complete CLI Documentation Page for detailed CLI Docs.

Reference