Speakeasy Logo
Skip to Content
DocumentationSpeakeasyCLIUsing with mise toolkit

Using Speakeasy CLI with mise toolkit

mise  (pronounced “MEEZ ahn plahs”) is a polyglot tool version manager that serves as the front-end to your dev environment. It can manage development tools, environments, and tasks, replacing tools like asdf, nvm, pyenv, rbenv, and others.

This guide shows how to install and manage the Speakeasy CLI using mise toolkit.

Prerequisites

First, you need to install mise on your system. Follow the mise installation guide  for your operating system.

After installation, add mise to your shell configuration:

Install Speakeasy CLI with mise

Once mise is installed and configured, you can install the Speakeasy CLI using one of the available backends:

Backend Selection

  • aqua: Recommended backend that offers the most features and security - ubi: Universal Binary Installer, simpler but with fewer features Both backends will install the same Speakeasy CLI functionality.

Verify Installation

After installation, verify that Speakeasy CLI is available:

You should see the version number of the installed Speakeasy CLI.

Managing Versions

Install a Specific Version

List Available Versions

Update to Latest Version

Project-Specific Configuration

You can configure Speakeasy CLI versions per project using mise’s configuration files:

Using .mise.toml

Create a .mise.toml file in your project root:

Using .tool-versions

Alternatively, use the .tool-versions format:

When you enter the project directory, mise will automatically use the specified version.

Authentication and Usage

After installing Speakeasy CLI with mise, authenticate and start using it:

For the full set of CLI commands, type speakeasy -h.

Using in CI/CD

To use Speakeasy CLI with mise in CI/CD pipelines:

Troubleshooting

Command Not Found

If speakeasy command is not found after installation:

  1. Ensure mise is properly activated in your shell
  2. Restart your terminal or run source ~/.bashrc (or ~/.zshrc)
  3. Verify the installation with mise list

Version Conflicts

If you have multiple version managers installed:

  1. Check which tools are managing Speakeasy: which speakeasy
  2. Ensure mise takes precedence in your PATH
  3. Consider uninstalling other version managers to avoid conflicts

Next Steps

Last updated on