Complete reference for all Embeddable CLI commands.
--help- Show help for any command--debug- Enable debug output--version- Show CLI version
Interactive setup wizard that guides new users through the complete configuration process.
embed setup
# or skip token generation
embed setup --skip-tokenWhat it does:
- Configure API authentication
- Create a database connection
- Set up an environment with data source mappings
- Optionally generate a security token
Initialize the CLI with your Embeddable API credentials.
embed initManage authentication credentials.
Update or change your API credentials.
embed auth loginClear stored credentials from your system.
embed auth logoutCheck your current authentication status and test API connectivity.
embed auth statusAdd a new database connection with support for interactive mode or JSON configuration.
Interactive mode:
embed database connectJSON mode:
embed database connect --json '{"name":"prod-db","type":"postgresql","host":"localhost","port":5432,"database":"mydb","user":"user","password":"pass"}'File mode:
embed database connect --file connection.jsonOptions:
--json <config>- Connection configuration as JSON--file <path>- Path to JSON file with connection configuration--skip-test- Skip connection test before creating
List all configured database connections.
embed database listTest a database connection to ensure it's working properly.
embed database test
# or specify connection
embed database test <connection-id>Remove a database connection.
embed database remove
# or specify connection
embed database remove <connection-id>Create a new environment with data source mappings.
embed env createList all environments.
embed env listSet the default environment for token generation.
embed env set-default
# or specify environment
embed env set-default <environment-id>Remove an environment.
embed env remove
# or specify environment
embed env remove <environment-id>List all available embeddables in your workspace.
embed listGenerate a security token for embedding a dashboard. Supports user context and row-level security.
embed token
# or specify embeddable
embed token <embeddable-id>
# or with specific environment
embed token <embeddable-id> --env <environment-id>Options:
--env <environment-id>- Use specific environment (overrides default)
Display the current CLI version.
embed versionCheck for available updates.
embed version --checkUpdate to the latest version (Homebrew installations only).
embed version --updateDisplay current configuration including region and masked API key.
embed config# 1. Initialize CLI
embed init
# 2. Add a PostgreSQL database
embed database connect
# Choose PostgreSQL, enter connection details
# 3. Create a production environment
embed env create
# Name it "production", map data sources
# 4. Set as default environment
embed env set-default
# 5. List available embeddables
embed list
# 6. Generate a token for embedding
embed token# Create connection from JSON file
embed database connect --file db-config.json
# Create environment and set as default
embed env create
embed env set-default production# Generate token with user context and security filters
embed token embeddable-123 --env production
# Follow prompts for user ID and security filtersFor detailed help with any command:
embed <command> --helpFor command-specific examples, see the Examples documentation.