@authx/tools
TypeScript icon, indicating that this package has built-in type declarations

3.1.0-alpha.55 • Public • Published

AuthX Strategy – Password

This package provides basic tools for interacting with an AuthX deployment.

CLI

This package provides and authx command-line interface which can be accessed as yarn authx <action> or npx authx <action>.

Actions

schema

Create the database schema.

bootstrap

Bootstrap a database by creating an initial root user and admin role, returning the user ID and password as JSON. Use the above environment variables to configure the postgres connection.

Pass the --schema argument to also create the database schema.

fixture

Add test fixtures to the database. Use the above environment variables to configure the postgres connection.

Pass the --schema argument to also create the database schema.

Environment Variables

When relevant, the following environment variables can be set to modify the CLI's behavior:

  • PGHOST: postgres host
  • PGPORT: postgres port
  • PGUSER: postgres user
  • PGPASSWORD: postgres password

Programmatic Access

This package also exports its actions for use in other node projects. See the source code for more details.

Dependencies (6)

Dev Dependencies (8)

Package Sidebar

Install

npm i @authx/tools

Weekly Downloads

5

Version

3.1.0-alpha.55

License

MIT

Unpacked Size

82.3 kB

Total Files

50

Last publish

Collaborators

  • mike-marcacci
  • ebrown32