Installation

This guide demonstrates the installation steps of ORAS CLI on different platforms.

Homebrew

Install oras using Homebrew:

brew install oras

Snap

Install oras using Snap:

snap install oras

Release artifacts

Install ORAS from the latest release artifacts:

Linux

To install ORAS on Linux, run the following command:

ARCH=$(uname -m | sed -e 's/x86_64/amd64/' -e 's/aarch64/arm64/' -e 's/armv7l/armv7/')
VERSION="1.1.0"
curl -fLO "https://github.com/oras-project/oras/releases/download/v${VERSION}/oras_${VERSION}_linux_${ARCH}.tar.gz"
mkdir -p oras-install/
tar -zxf oras_${VERSION}_linux_${ARCH}.tar.gz -C oras-install/
sudo mv oras-install/oras /usr/local/bin/
rm -rf oras_${VERSION}_linux_${ARCH}.tar.gz oras-install/

macOS

To install ORAS on a Mac computer, run the following command:

ARCH=$(uname -m | sed -e 's/x86_64/amd64/')
VERSION="1.1.0"
curl -fLO "https://github.com/oras-project/oras/releases/download/v${VERSION}/oras_${VERSION}_darwin_${ARCH}.tar.gz"
mkdir -p oras-install/
tar -zxf oras_${VERSION}_darwin_${ARCH}.tar.gz -C oras-install/
sudo mv oras-install/oras /usr/local/bin/
rm -rf oras_${VERSION}_darwin_${ARCH}.tar.gz oras-install/

Windows

• You can install ORAS CLI on Windows using WinGet (Windows Package Manager):

winget install oras --version 1.1.0

• Alternatively, you can install ORAS CLI from the .zip release archive. Add %USERPROFILE%\bin\ to your PATH environment variable so that oras.exe can be found.

set "VERSION=1.1.0"
curl.exe -fLO "https://github.com/oras-project/oras/releases/download/v%VERSION%/oras_%VERSION%_windows_amd64.zip"
tar.exe -xvzf oras_%VERSION%_windows_amd64.zip
if not exist "%USERPROFILE%\bin" mkdir "%USERPROFILE%\bin"
copy /Y oras.exe "%USERPROFILE%\bin\oras.exe"
set PATH=%USERPROFILE%\bin\;%PATH%

Docker Image

A public Docker image containing the CLI is available on GitHub Container Registry:

docker run -it --rm -v $(pwd):/workspace ghcr.io/oras-project/oras:v1.1.0 help

note

The default WORKDIR in the image is /workspace.

Nix

Nix is a tool that takes a unique approach to package management and system configuration.

The Nix Packages collection (Nixpkgs) is a set of over 80 000 packages for the Nix package manager.

oras also has a Nix package available in the Nixpkgs repository.

info

You can install nix CLI from here.

You can install oras using the following command:

nix-env -iA nixpkgs.oras

Verify

$ oras version
Version:        1.1.0
Go version:     go1.21.0
Git commit:     7079c468a06fb5815c99395eb4aaf46dd459d3fa
Git tree state: clean

You can check out our how-to guide if you would like to verify ORAS CLI Binaries.