docs CLI
Launch Nametag Get help

CLI

Install Nametag CLI

nametag is a command-line utility that lets you work with Nametag using commands, from configuring accounts and environments to performing directory integrations. It runs on your local device so you’ll want to install the version that’s appropriate for your operating system.

MacOS

If you have the Homebrew package manager installed, nametag can be installed by running:

$ brew install nametaginc/tap/nametag

If not, you can run the installation script:

$ curl -L https://nametag.co/install.sh | sh

If you used curl to install nametag, then you need to add the Nametag directory to your PATH. Check the output of the install script for the entries to copy and paste into your shell configuration file. It will look something like this:

Manually add the directory to your $HOME/.zshrc (or similar)
  export NAMETAG_INSTALL="*HOME_DIRECTORY*/.nametag"
  export PATH="$NAMETAG_INSTALL/bin:$PATH"

You may also need to restart your terminal or run source ~/.zshrc (or similar) to pick up the changes. Now you can use the nametag command from any directory.

Linux

Run the installation script:

$ curl -L https://nametag.co/install.sh | sh

Windows

Run the PowerShell install script:

$ pwsh -Command "iwr https://nametag.co/install.ps1 -useb | iex"

If you encounter an error saying the pwsh command is not found, you can use powershell instead or install the latest version of PowerShell.

Configure authentication

To authenticate to your Nametag account, run:

nametag auth login

This will open a web browser and prompt you to sign in to Nametag. After you sign in, an authentication token will be written to ~/config/nametag/.config.yaml.

You can also use the --auth-token flag or NAMETAG_AUTH_TOKEN environment variable to specify an API key.

Next steps

Run nametag --help for a tour of the available commands