LinuxCommandLibrary

propelauth

Manage and interact with PropelAuth services

TLDR

Login to PropelAuth using an API Key generated from

$ propelauth login
copy

Set the default PropelAuth Project for the CLI. If no default project is set, the system will prompt for selecting a Project each time certain commands are run
$ propelauth set-default-project
copy

Install PropelAuth authentication in an application. If no directory is provided, the current directory is used
$ propelauth setup [[-f|--framework]] [path/to/directory]
copy

Log the CLI out of PropelAuth
$ propelauth logout
copy

SYNOPSIS

propelauth [command] [options]

PARAMETERS

help
    Displays help information about the command and its available options.

login
    Authenticates the user with the PropelAuth service.

logout
    Logs out the currently authenticated user.

users
    Manages PropelAuth users, with options to create, list, update and delete.

roles
    Manages PropelAuth roles, with options to create, list, update, and delete.

permissions
    Manages PropelAuth permissions, with options to create, list, update, and delete.

settings
    Configures the PropelAuth project settings.

DESCRIPTION

The `propelauth` command provides a command-line interface (CLI) for interacting with PropelAuth, a service simplifying user authentication and authorization in web applications. It likely allows developers to manage users, roles, permissions, and settings within their PropelAuth project directly from the terminal. Typical functions might involve creating, updating, and deleting users, assigning roles to users, defining permissions, and configuring other authentication-related parameters. The CLI streamlines the integration process, allowing developers to avoid manual manipulation of the PropelAuth API or web interface. It greatly reduces the time and effort involved in managing authentication and authorization tasks.
This tool allows developers to quickly bootstrap and manage their authentication setup, freeing them up to focus on building core application features. Furthermore, this would simplify deploying changes through automated scripts.

CAVEATS

The availability of specific commands and options depends on the PropelAuth service version and user permissions. Proper authentication is required before using most commands.

EXAMPLE USAGE

To list all users: propelauth users list
To create a new user: propelauth users create --email user@example.com

Copied to clipboard