diana esteves caf8ef3c08 fix3548
2023-11-01 17:28:34 -05:00

11 KiB

title_tag, meta_desc, title, h1, meta_image, menu, search
title_tag meta_desc title h1 meta_image menu search
Download & Install Pulumi ESC Detailed instructions for downloading and installing Pulumi ESC (Environments, Secrets and Configuration). Pulumi ESC Download & Install Pulumi ESC /images/docs/meta-images/docs-meta.png
install
weight
2
boost keywords
true
install
homebrew
cli

Select an Operating System

{{< chooser os "macos,windows,linux" >}}

{{% choosable os macos %}}

Homebrew Package Manager

$ brew update && brew install pulumi/tap/esc

macOS Binary Download

amd64 arm64

macOS Sierra (10.12) or later is required.

The latest version of Pulumi ESC is {{< latest-version-esc >}}.

{{< esc-get-started-note >}}

{{% /choosable %}}

{{% choosable os linux %}}

Install Script

$ curl -fsSL https://get.pulumi.com/esc/install.sh | sh

Linux Binary Download

amd64

The latest version of Pulumi ESC is {{< latest-version-esc >}}.

{{< esc-get-started-note >}}

{{% /choosable %}}

{{% choosable os windows %}}

Windows Binary Download

amd64

Windows 8 and later are supported.

The latest version of Pulumi ESC is {{< latest-version-esc >}}. For older versions, see Available Versions.

{{< esc-get-started-note >}}

{{% /choosable %}}

{{% /chooser %}}

Other installation methods

In addition, there are many ways to install Pulumi ESC:

{{< chooser os "macos,windows,linux" >}} {{% choosable os macos %}}

You can install Pulumi ESC through the Homebrew package manager and using our official Pulumi Homebrew Tap

$ brew update && brew install pulumi/tap/esc

This will install the esc CLI to the usual place (often /usr/local/bin/esc) and add it to your path.

Subsequent updates can be installed in the usual way:

$ brew upgrade esc

A Pulumi formula is available on the Community Homebrew. If you do not have the Pulumi tap installed, then you can still install Pulumi ESC from homebrew using the command:

$ brew install esc

To install, run our installation script:

$ curl -fsSL https://get.pulumi.com/esc/install.sh | sh

This will install the esc CLI to ~/.pulumi/bin and add it to your path. When it can't automatically add esc to your path, you will be prompted to add it manually.

See How to permanently set $PATH on Unix for guidance.

The installer script can be rerun to subsequently install new updates.

If you do not wish to use the previous options, you can install Pulumi manually.

  1. Download [Pulumi ESC {{< latest-version-esc >}} for macOS](https://get.pulumi.com/esc/releases/esc-v{{< latest-version-esc >}}-darwin-x64.tar.gz).
  1. Extract the tarball and move the binaries in the esc directory to a directory included in your system's $PATH.

{{% /choosable %}}

{{% choosable os linux %}}

To install, run our installation script:

$ curl -fsSL https://get.pulumi.com/esc/install.sh | sh

This will install the esc CLI to ~/.pulumi/bin and add it to your path. When it can't automatically add esc to your path, you will be prompted to add it manually.

See How to permanently set $PATH on Unix for guidance.

Alternatively, you can install Pulumi ESC manually. We provide a prebuilt binary for Linux.

  1. Download [Pulumi ESC {{< latest-version-esc >}} for Linux x64](https://get.pulumi.com/esc/releases/esc-v{{< latest-version-esc >}}-linux-x64.tar.gz).
  1. Extract the tarball and move the binaries in the esc directory to a directory included in your system's $PATH.

{{% /choosable %}}

{{% choosable os windows %}}

  1. Open a new command prompt window (WIN+R: cmd.exe):

  2. Run our installation script:

> @"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -NoProfile -InputFormat None -ExecutionPolicy Bypass -Command "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; iex ((New-Object System.Net.WebClient).DownloadString('https://get.pulumi.com/esc/install.ps1'))" && SET "PATH=%PATH%;%USERPROFILE%\.pulumi\bin"

This will install the esc.exe CLI to %USERPROFILE%\.pulumi\bin and add it to your path.

Alternatively, you can install Pulumi ESC manually using binaries built for Windows x64.

  1. Download [Pulumi ESC {{< latest-version-esc >}} binaries for Windows x64](https://get.pulumi.com/esc/releases/esc-v{{< latest-version-esc >}}-windows-x64.zip). For prior versions and release notes, see the Available Versions page.
  1. Unzip the file and extract the contents to a folder such as C:\esc.

  2. Add C:\esc\bin to your path via System Properties -> Advanced -> Environment Variables -> User Variables -> Path -> Edit.

{{% /choosable %}}

{{% /chooser %}}

Verify installation

After installing Pulumi ESC, verify everything is in working order by running the esc CLI:

{{% chooser os "macos,windows,linux" %}}

{{% choosable os macos %}}

$ esc version
v{{< latest-version-esc >}}

{{% /choosable %}}

{{% choosable os linux %}}

$ esc version
v{{< latest-version-esc >}}

{{% /choosable %}}

{{% choosable os windows %}}

> esc version
v{{< latest-version-esc >}}

{{% /choosable %}}

{{% /chooser %}}

Common errors and warnings

These are common installation-related errors or warnings you may encounter.

Pulumi ESC not found error

If you get an error that esc could not be found, it means your path has not been configured correctly. Verify that your system's $PATH contains the directory containing the esc CLI installed earlier.

Uninstalling Pulumi ESC

To uninstall Pulumi ESC, use your installation method's command of choice. If you installed Pulumi ESC manually, delete the esc directory that you created. Afterwards, remove the .pulumi folder from your home directory which contains plugins and other cached metadata.