Embeddable CLI

A command-line interface for managing Embeddable analytics platform resources. The CLI provides an intuitive way to manage database connections, environments, and generate security tokens for embedding dashboards.

Quick Start

The easiest way to get started is with the interactive setup wizard:

embed setup

This will guide you through configuring your API credentials, setting up database connections, and creating environments.

Installation

Homebrew (macOS/Linux)

brew tap embeddable-hq/embeddable
brew install embed

Scoop (Windows)

scoop bucket add embeddable https://github.com/embeddable-hq/scoop-bucket
scoop install embed

Direct Download

Download pre-built binaries from the releases page.

Documentation

• Getting Started - First steps and setup wizard
• Installation Guide - Detailed installation instructions
• Commands Reference - Complete command documentation
• Configuration - Configuration and regions
• Database Connections - Supported databases and setup
• Environments - Environment management
• Security Tokens - Token generation and usage
• Examples - Common workflows and examples
• Troubleshooting - Common issues and solutions
• Development - Contributing and building from source

Support

• Issues: GitHub Issues
• Documentation: Embeddable Docs
• Community: Embeddable Community

License

MIT License - see LICENSE file for details.