https://github.com/loginradius/lr-cli
lr is LoginRadius on the command line. You can perform basic actions of your LoginRadius Dashboard through command line. The actions includes login, register, logout, email configuration, domain whitelisting etc.
https://github.com/loginradius/lr-cli
authentication ciam cli hacktoberfest hacktoberfest2021
Last synced: 10 months ago
JSON representation
lr is LoginRadius on the command line. You can perform basic actions of your LoginRadius Dashboard through command line. The actions includes login, register, logout, email configuration, domain whitelisting etc.
- Host: GitHub
- URL: https://github.com/loginradius/lr-cli
- Owner: LoginRadius
- License: mit
- Created: 2021-03-05T06:47:03.000Z (almost 5 years ago)
- Default Branch: develop
- Last Pushed: 2023-06-02T07:33:47.000Z (over 2 years ago)
- Last Synced: 2025-03-25T06:07:25.828Z (10 months ago)
- Topics: authentication, ciam, cli, hacktoberfest, hacktoberfest2021
- Language: Go
- Homepage:
- Size: 6.81 MB
- Stars: 11
- Watchers: 7
- Forks: 12
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# LoginRadius CLI
`lr` is LoginRadius on the command line. You can perform basic actions of your [LoginRadius Admin Console](https://adminconsole.loginradius.com/dashboard) through command line. The actions includes **login, logout, email configuration, domain whitelisting etc**.
# Documentation
[See the manual](https://www.loginradius.com/open-source/cli/manual) for more information related to the commands.
# Installation
## MacOS and Linux
`lr` is available via [Homebrew](https://brew.sh/) and as a downloadable binary from the [release page](https://github.com/loginradius/lr-cli/releases/latest).
### How do I install this formulae using homebrew?
#### Install the tap via:
```sh
$ brew tap loginradius/tap
```
#### Then you can install LR CLI via:
```sh
$ brew install lr
```
### How to Upgrade the loginradius cli using Homebrew?
```sh
$ brew upgrade loginradius/tap/lr
```
## Other Platforms
Download packaged binaries from the [release page](https://github.com/loginradius/lr-cli/releases/latest).
## Build from Source
### Installation from source
0. Verify that you have Go 1.16+ installed
```sh
$ go version
```
If `go` is not installed, follow instructions on [the Go website](https://golang.org/doc/install).
1. Clone this repository
```sh
$ git clone https://github.com/LoginRadius/lr-cli.git
$ cd lr-cli
```
2. Build and install
#### Unix-like systems
```sh
# installs to '/usr/local' by default; sudo may be required
$ make install
```
#### Windows
```sh
# 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](CONTRIBUTING.md) 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](CODE_OF_CONDUCT.md).
## License
For more information on licensing, please refer to [License](https://github.com/LoginRadius/lr-cli/blob/master/LICENSE)