Speechly's Command Line Interface lets you manage your projects and applications, deploy new versions, download configurations, evaluate accuracy and more.

Installation

To install Speechly CLI, open your terminal and run:

# Using Homebrew
brew tap speechly/tap
brew install speechly

# Using Scoop
scoop bucket add speechly https://github.com/speechly/scoop-bucket
scoop install speechly

There are binary releases for macOS, Linux and Windows, see GitHub Releases. Also a Docker image is built and published.

Usage

After installing and authenticating Speechly CLI, you can get a list of commands by running:

speechly

To get a list of available sub-commands, arguments & flags run:

speechly [command]

Speechly CLI follows an approach similar to git or docker, where different functionalities of the tool are accessed by specifying a command followed by arguments to this command.

Documentation

See Using Speechly CLI to learn more about how to use the tool.

For a full command reference, see Speechly CLI reference or the docs folder.

Generate documentation

Docs are generated when running make.

You can run the generate script separately:

go run docs/generate.go docs
# or if inside /docs directory
go run generate.go .

Compile and run tests

There are github actions for CI/CD, and locally you can run make test to run tests and make lint to run golangci-lint for the code.

Speechly API access

See the Speechly API for more information about the API and how to access it, as well as documentation.