LoginRadius CLI

lr is LoginRadius on the command line. You can perform basic actions of your LoginRadius Admin Console through command line. The actions includes login, logout, email configuration, domain whitelisting etc.

Documentation

See the manual for more information related to the commands.

Installation

MacOS and Linux

lr is available via Homebrew and as a downloadable binary from the release page.

How do I install this formulae using homebrew?

Install the tap via:

$ brew tap loginradius/tap

Then you can install LR CLI via:

$ brew install lr

How to Upgrade the loginradius cli using Homebrew?

$ brew upgrade loginradius/tap/lr

Other Platforms

Download packaged binaries from the release page.

Build from Source

Installation from source

0. Verify that you have Go 1.16+ installed

   $ go version

   If go is not installed, follow instructions on the Go website.

1. Clone this repository

   $ git clone https://github.com/LoginRadius/lr-cli.git
   $ cd lr-cli

2. Build and install

   Unix-like systems

   # installs to '/usr/local' by default; sudo may be required
   $ make install
   

   Windows

   # build the `bin\gh.exe` binary
   > go run script/build.go

   There is no install step available on Windows.

3. Run lr --help to check if it worked.

   Windows

   Run bin\lr --help to check if it worked.

Contributing

We encourage you to contribute to LoginRadius CLI! Please check out the Guidelines for Contributing and become a contributor.

Everyone interacting in LoginRadius CLI codebases, issue trackers, chat rooms, and mailing lists is expected to follow the LoginRadius code of conduct.

License

For more information on licensing, please refer to License