Blackbird CLI

The Ambassador Blackbird Command-Line Interface (CLI) is a versatile command-line tool you can use to streamline your API development process. This document includes installation instructions, command syntax, and usage examples to help you efficiently integrate the CLI into your workflow. It includes CLI details related to the following:

• General: Log in, log out, view version information, and more.
• API: Create and manage APIs in the Blackbird catalog.
• API key: Create and manage API keys to secure your endpoints.
• Mock: Create and manage mock instances to test your API specification.
• Code: Generate, run, and debug your API specification code.
• Cluster: Connect to a cluster, intercept a cluster, and more.
• Deployment: Manage your deployments.
• Organization: Manage users and organizations.
• Token: Create and manage tokens for headless authentication.

Consider the following when using this reference:

• The CLI is available on Linux, macOS, and Windows.
• Running blackbird --help outputs the entire list of commands.
• All commands also have the flags --help or -h, which display available flags, arguments, and subcommands.
• All examples use an API named Simple API, which has a slug name of simple-api.

Getting started with the Blackbird CLI

The Blackbird CLI is available to install in Windows, macOS, and Linux environments. After you finish the installation, log in to begin using the Blackbird CLI.

Install the CLI

Use Powershell or the Windows Command Prompt (CMD) to install the CLI.

Log into Blackbird

After you download the CLI, run the following command in Powershell or the Windows Command Prompt (CMD) to open a browser tab you can use to log in.