CLI Reference

This page provides documentation for the command line api_key_factory application.

generate

Command to generate API keys and their corresponding SHA-256 hashes.

Args: output_dir (click.Path): Directory to output keys and hashes. num (int): Number of API keys to generate. Default 1. prefix (str): Prefix at the beginning of the key.

Raises: click.ClickException: Error when writing output files

Usage:

generate [OPTIONS]

Options:

  -d, --dir DIRECTORY      Directory to output keys and hashes. If not set
                           output to stdout.
  -n, --num INTEGER RANGE  Number of API keys to generate  [x>=1]
  -p, --prefix TEXT        Add a prefix at the beginning of the key
  --help                   Show this message and exit.