CLI Random String Generator

A TypeScript-based CLI tool for generating random strings with customizable options.

Installation

npm install -g @grelas/cli-random-string

Usage

# Generate a random string with default settings (16 characters)
random-string

# Generate a string with specific length
random-string --length 32

# Generate a string with specific character types
random-string --uppercase --numbers --special

# Generate a string excluding certain characters
random-string --exclude "!@#$"

# Combine options for a custom string
random-string --length 24 --uppercase --lowercase --numbers --special --exclude "!@#$"

Programmatic Usage

You can also use the string generator programmatically in your TypeScript/JavaScript code:

import { generateString } from '@grelas/cli-random-string';

// Generate with default options (16 characters, all character types)
const defaultString = generateString();

// Generate with custom options
const customString = generateString({
  length: 32,
  uppercase: true,
  lowercase: true,
  numbers: true,
  special: false,
  exclude: '!@#$',
  format: 'plain'
});

The generateString function accepts a partial GeneratorOptions object with the following properties:

• length: Number of characters (default: 16)
• uppercase: Include uppercase letters (default: true)
• lowercase: Include lowercase letters (default: true)
• numbers: Include numbers (default: true)
• special: Include special characters (default: true)
• exclude: String of characters to exclude (default: '')
• format: Output format, currently supports 'plain' (default: 'plain')

Options

• --length, -l: Length of the generated string (default: 16)
• --uppercase, -u: Include uppercase letters (A-Z)
• --lowercase, -l: Include lowercase letters (a-z)
• --numbers, -n: Include numbers (0-9)
• --special, -s: Include special characters (!@#$%^&*()_+-=[]{}|;:,.<>?)
• --exclude, -e: Characters to exclude from the output

Troubleshooting

• Error: Length must be a positive integer
  Ensure the --length option is a positive number.

• No output generated
  Check that at least one character type (uppercase, lowercase, numbers, special) is enabled.

Development

# Install dependencies
npm install

# Run tests
npm test

# Build the project
npm run build

# Lint the code
npm run lint

License

MIT