Skip to main content

Installation

Ory CLI is a convenient and easy-to-use tool that helps you manage and configure Ory Cloud and self-hosted projects.

Its functionality is essential for self-hosting Ory components and local development. The built-in proxy and tunneling mechanisms help route application traffic to the appropriate endpoints in a safe and hassle-free manner.

The ability to export configurations allows you to bring your setup from a self-hosted environment to the cloud and from Ory Cloud to self-hosted setups alike.

info

The Ory CLI is under active development. This means that new features are added with every release.

Installation​

You can install Ory CLI directly on your machine, or run the tool in Docker.

macOS​

Run this command to install the CLI using Homebrew:

brew install ory/tap/cli

Verify the installation:

ory help

Linux​

Ory CLI works on all Linux distributions. Run this command to install:

bash <(curl https://raw.githubusercontent.com/ory/meta/master/install.sh) -b . ory

You may want to move the Ory CLI to your $PATH:

sudo mv ./ory /usr/local/bin/

Verify the installation after moving to $PATH:

ory help

Windows​

To install the CLI on Windows, use scoop. Run:

> scoop bucket add ory https://github.com/ory/scoop.git
> scoop install ory

Verify the installation:

ory help

Docker​

warning

If you run Ory CLI in Docker, you can't Ory Proxy and Ory Tunnel.

### Pull Ory CLI image
docker pull oryd/ory

### Run image, enter container, and run a CLI command
docker run --rm -it oryd/ory help

Binary​

You can download the server and client binaries from the GitHub "releases" tab.

To install, add the binary to the PATH environment variable or move it to a path that's already in your $PATH, for example /usr/local/bin.