kinde-cli

Kinde command line utility

Status

This is a work in progress. APIs may change without notice or be missing.

Features

• Official CLI for interacting with Kinde APIs.
• Secure handling of credentials via OS-specific secrets store.
• Verifiable authenticity
  • single native binary for ease of maintenance and deployment
  • Ships for multiple platforms - Linux, MacOS, Windows
  • Ships for multiple architectures - x64, i386, ARM, Apple ARM
  • Each variation comes with the checksum to verify authenticity
• Secure by default. Kinde business cannot be managed via the CLI until a new M2M application is created with the management API authorized and the select scopes granted.

TODO:

• Client-credentials authentication
• Management API top-level sub-commands and flags
• Online token verification
  • Offline token verification
• Support for user tokens and account API
  • Spport for account API

Getting Started

Installation

Download a pre-built binary from Releases.

Or install from source using go:

go install github.com/kinde-oss/kinde-cli/cmd/kinde@latest

Quick Start and top-level commands

kinde help for top-level help

kinde help <command> to get options for each command

Authentication

To login using client credentials

kinde login --domain <your Kinde business domain> \
--client_id <M2M application> \
--client_secret <M2M application secret> 

To login using device authorization flow

Please configure a default application for device flow or specify client_id

kinde login
    --domain <your Kinde business domain>
    --client_id [optional]

Check authentication status

Terminal autocomplete

Kinde CLI comes with terminal autocompletion support for bash, fish, powershell, and zsh

You can see instructions for your shell/OS combination by executing the following

kinde help completion <bash|fish|powershell|ash>

1. Use kinde <command> to interact with your Kinde account.

Usage

Commands

• login – Authenticate with Kinde.
  • Multi-tenancy is supported via --domain <your Kinde business domain>
• logout – Remove authentication credentials.
• whoami – Show current authenticated token details.
• manage - provides access to management API
• help – Show help for commands.

Flags

• --help – Show help information.

Management API sub-commands

• api_keys

• apis

• applications

• billing

• business

• categories

• connected_apps

• connections

• environment_variables

• environments

• events

• feature_flags

• industries

• organizations

• permissions

• properties

• roles

• subscribers

• timezones

• users

• webhooks

Configuration

Configuration is stored in $HOME/.kinde/config.json by default for *nix-based systems, <user profile>\.config\kinde\config.json for Windows. You can set API keys, business, and other preferences.

Example:

{
  "current": "mybusiness.kinde.com",
  "environments": {
    "mybusiness.kinde.com": {
      "domain_name": "app.kinde.com"
    },
    "mybusiness2.localkinde.com": {
      "domain_name": "app.localkinde.com"
    },
    "mybusiness2.kinde.com": {
      "domain_name": "mybusiness2.kinde.com",
      "client_id": "xxx",
      "client_secret": "yyy"
    }
  }
}

Examples

• List users:

  kinde manage users get_all --page_size 2
  

• Show token details of the logged-in user:

  kinde whoami
  

• Create a user

  kinde manage users create
  

• Create an environment-level feature-flag of type string

    kinde manage feature_flags create --name "first flag" --key "first_key" --allow_override_level "env" --type "str"
  

Troubleshooting

• CLI validates the token against public JWKS and requires internet connectivity.
• Check your configuration file for errors.
• Ensure your API credentials are valid. To use management API, please create an M2M application and grant it access to the management API, enable appropriate scopes to grant the specific level of access.

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

License

This project is licensed under the MIT License. See LICENSE for details.

Changelog

See CHANGELOG.md for release notes and version history.