cli

Algolia CLI

The Algolia CLI lets you work with your Algolia resources, such as indices, records, API keys, and synonyms, and from the command line.

Documentation

See Algolia CLI in the Algolia documentation for setup and usage instructions.

Installation

npm (any platform)

The Algolia CLI is published on npm as @algolia/cli.

Run without installing:

npx @algolia/cli --help

Or install globally:

npm install -g @algolia/cli

macOS

The Algolia CLI is available on Homebrew and as a downloadable binary from the releases page.

brew install algolia/algolia-cli/algolia

Linux

The Algolia CLI is available as a .deb package:

# Select the package appropriate for your platform:
sudo dpkg -i algolia_*.deb

as a .rpm package:

# Select the package appropriate for your platform
sudo rpm -i algolia_*.rpm

or as a tarball from the releases page:

# Select the archive appropriate for your platform
tar xvf algolia_*_linux_*.tar.gz

Windows

The Algolia CLI is available via Chocolatey and as a downloadable binary from the releases page

Community packages

Other packages are maintained by the community, not by Algolia. If you distribute a package for the Algolia CLI, create a pull request so that we can list it here!

Build from source

To build the Algolia CLI from source, you'll need:

• Go version 1.23 or later
• Go task

1. Clone the repo: git clone https://github.com/algolia/cli.git algolia-cli && cd algolia-cli
2. Run: task build

Get started

Sign in

Sign in through the browser (this also lets you sign up if you don't have an account yet):

algolia auth login

If your account has no application, the CLI prompts you to create one. On a machine without a browser (SSH, container), use algolia auth login --no-browser. Check your status anytime with algolia auth status.

Choose an application

algolia application list                                 # list your applications
algolia application select                               # set the current one
algolia application create --name "My App" --region EU   # regions: EU, UK, USC, USE, USW

Index and search your first records

algolia objects import MOVIES -F movies.ndjson           # import records into the MOVIES index
algolia search MOVIES --query "toy story"                # search them

Support

If you found an issue with the Algolia CLI, open a new GitHub issue, or join the Algolia community on Discord.