@fusionauth/cli

FusionAuth CLI

The FusionAuth CLI is a command line tool for interacting with FusionAuth. It is written in Typescript and is available as an NPM package.

Requirements

• A modern version of node (tested on 19, 20 and 22)
• A FusionAuth instance (download it here: https://fusionauth.io/download)

Installation & usage

To install and use @fusionauth/cli, run the following commands:

npm i @fusionauth/cli;
npx fusionauth --help;

You can install it globally for ease of use from anywhere, but global installations can potentially lead to conflicts and are not recommended:

npm i -g @fusionauth/cli;
fusionauth --help;

Currently, the CLI supports the following commands:

• Emails
  • fusionauth email:download - Download a specific template or all email templates from a FusionAuth server.
  • fusionauth email:duplicate - Duplicate an email template locally.
  • fusionauth email:html-to-text - Convert HTML email templates to text, where the text template is missing.
  • fusionauth email:upload - Upload a specific template or all email templates to a FusionAuth server.
  • fusionauth email:watch - Watch the email template directory and upload changes to a FusionAuth server.
  • fusionauth email:create - Create a new email template locally.
• Lambdas
  • fusionauth lambda:create - Upload a lambda to a FusionAuth server.
  • fusionauth lambda:delete - Delete a lambda from a FusionAuth server.
  • fusionauth lambda:retrieve - Download a lambda from a FusionAuth server.
• Themes
  • fusionauth theme:download - Download a theme from a FusionAuth server.
  • fusionauth theme:upload - Upload a theme to a FusionAuth server.
  • fusionauth theme:watch - Watch a theme directory and upload changes to a FusionAuth server.

Instead of supplying the API key with the -k option on every command, you can set the FUSIONAUTH_API_KEY environment variable. The same goes for the host URL option -h, which can be set with the FUSIONAUTH_HOST environment variable.

The download and retrieve commands will succeed even if there are no templates or lambdas to retrieve.

Questions and support

If you have a question or support issue regarding this client library, we'd love to hear from you.

If you have a paid edition with support included, please open a ticket in your account portal. Learn more about paid editions here.

Otherwise, please post your question in the community forum.

Releasing

Run the Publish Workflow.

Contributing

Bug reports and pull requests are welcome on GitHub.

To build this library locally:

git clone https://github.com/FusionAuth/fusionauth-node-cli &&
cd fusionauth-node-cli;
npm install &&
npm run build;

# now you can use it
npx fusionauth -h;

To see examples of use look at https://fusionauth.io/docs/v1/tech/lambdas/testing.

License

This code is available as open source under the terms of the Apache v2.0 License.