<% user.full_name %>
<% util.level ? util.level.title : '' %>
Explorer Pioneer Apollo Viking Voyager Pathfinder Orion
Points
<% user.points ? user.points.toLocaleString() : 0 %>
Badges
<% util.badgeCount %>
Streaks
Congratulations You've <% util.newestBadge.isCurriculum ? 'completed' : 'earned' %> the
<% util.newestBadge.title %> <% util.newestBadge.isCurriculum ? 'curriculum' : 'badge' %>!
previous
next
Share to Social Media
Linked In Facebook
Status
<% util.level ? util.level.title : '' %>
<% util.level ? util.level.points : '' %>
<% util.nextLevel ? util.nextLevel.title : '' %>
<% util.nextLevel ? util.nextLevel.points : '' %>
Level up! <% util.levelPointsRemaining %> points to go
Level up! <% util.levelPointsRemaining %> points to go
Badges
Completed Hitchhikers Program Track Completed Content Track Completed Pages Track Completed Page Builder Track Completed Search Backend Track Completed Search Frontend Theme Track Completed Search UI React Track Completed Solution Templates and the Admin Console Track Completed Technical Skills Track Completed Platform Basics Track Completed Listings Track Completed Reviews Track Completed Industry Overview Track Completed Analytics Track Completed Industry Overview & Product Basics Track Completed Knowledge Assistant Track Completed Multi-Language Experiences Track Completed Fall '22 Release Highlights Track Completed Spring '23 Release Highlights Track Completed Chat Track Completed Summer '23 Release Highlights Track Completed Fall '23 Release Highlights Track
<% util.expandBadges ? 'Less' : 'More' %>
Playground Accounts
New +
No Playground Accounts
Create Playground +
View Profile
Log Out loading
Mission Complete! 🚀
Congratulations, you’ve completed your first module!

We hope you enjoy exploring the rest of the site. Please don’t forget to leave us feedback - we are constantly looking to improve. Happy Hitchhiking!
Home
Welcome to Hitchhikers! 👋
To learn more about the platform we encourage you to get started by completing the Hitchhikers Program Track and earning your first badge!
Start Here
Close notification
< DOCS HOME
Search
CLI & Configuration Resources
No results in this galaxy.
Try searching all of Hitchhikers here.
Introduction
Overview
Overview
Installation
Installation
Install on Mac
Install on Windows
Install on Linux
Download the Latest Executable
Enable Autocompletion
Getting Started
Getting Started
Link Your Account
Exploring Commands & Using the Help Flag
Universal Commands
Universal Commands
init
info
completion
Resources Command Group
Resources Commands
apply
diff
pull
copy
Service Users Command Group
Service Users Commands
activate
create
list
remove
home

Installation

Install on Mac

Install using Homebrew

If you are using Mac, you can install the Yext CLI using Homebrew . If you don’t already have Homebrew installed, follow the installation instructions on the Homebrew site first. Then, you can run the following command to install the Yext CLI on your machine:

brew install yext/tap/yext

If the Yext CLI is already installed, you can upgrade your version with the following command:

brew upgrade yext


Debugging on a Mac

If you run into problems installing or running the CLI, look through the following debugging steps:

  1. Make sure which yext outputs /usr/local/bin/yext. If not, run the following command and then open up a new bash shell before running the CLI again.

    rm -f <output of "which yext">

  2. Make sure there is no alias for yext with alias yext.

  3. Run brew untap yext/tap and then brew install yext/tap/yext.


Install on Windows

Install with MSI Installer

If you are using a Windows machine, we recommend installing with MSI Installer.

  1. Download the Yext CLI MSI installer for Windows: https://yext-cli-pub.s3.amazonaws.com/cli/windows/yext.msi

  2. Run the downloaded MSI installer and follow the on-screen instructions. By default, the Yext CLI installs to C:\Windows\system32

  3. Open Powershell and run yext init to get started.


Install on Linux

If you are using Linux, The Yext CLI can be installed via wget.

  1. Download the file: wget https://yext-cli-pub.s3.amazonaws.com/cli/linux/yext.
  2. Put into path: sudo mv yext /usr/local/bin.
  3. Make it executable: chmod +x /usr/local/bin/yext.


Download the Latest Executable

You can download the latest executable directly here:


Enable Autocompletion (bash/zsh/powershell only)

Enabling autocompletion in the CLI will allow you to partially type a command and then press the tab key to fill in the rest of the command. If you installed the Yext CLI using brew, this should happen automatically.

To enable autocompletion for the Yext CLI, follow the instructions generated by $ yext completion –help or the instructions found in our CLI reference for yext completion .

Feedback