README
¶
Command-line tools for Nametag
Install
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 install 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 shell rc file. Check the output of the install script for the entries to copy and paste into the file. Now you can use the nametag command from any directory.
Linux
Run the install 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, powershell can be used instead, though we recommend installing the latest version of PowerShell.
Configure Authentication
You can use a Nametag API key to authenticate by setting the environment variable NAMETAG_AUTH_TOKEN of the --auth-token command line argument.
Next Steps
Run nametag --help for a tour of the available commands
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package diragentapi provides primitives to interact with the openapi HTTP API.
|
Package diragentapi provides primitives to interact with the openapi HTTP API. |
|
Package directory contains type definitions for directory providers.
|
Package directory contains type definitions for directory providers. |
|
dirad
Package dirad implements an Active Directory agent
|
Package dirad implements an Active Directory agent |
|
dirad/adclient
Package adclient interacts with AD domain controllers
|
Package adclient interacts with AD domain controllers |
|
dirauthentik
Package dirauthentik implements an Authentik directory provider.
|
Package dirauthentik implements an Authentik directory provider. |
|
dirldap
Package dirldap implements an LDAP agent
|
Package dirldap implements an LDAP agent |
|
dirokta
Package dirokta impements an Okta directory provider.
|
Package dirokta impements an Okta directory provider. |
|
internal
|
|
|
api
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
cli
Package cli contains implementation of the Nametag cli subcommands
|
Package cli contains implementation of the Nametag cli subcommands |
|
config
Package config is for the nametag cli config
|
Package config is for the nametag cli config |
|
diragent
Package diragent implements the client part of the directory agent protocol.
|
Package diragent implements the client part of the directory agent protocol. |