Skip to content

API Reference

Jump to bottom
harish2222 edited this page Jun 19, 2026 · 3 revisions

Forgum API Reference

This document provides a comprehensive reference for all public functions exposed by the Forgum PowerShell module.

forgum (The Universal Keyword)

As of version 1.1.2, all functionality is accessible through the single forgum keyword.

Usage

# Standard Default Action (Cowsay + Fortune)
forgum [-Lolcat] [-Animation <mode>] [-Cow <name>] ["<custom text>"]

# Configuration & Setup
forgum config # Opens TUI

# Update
forgum update [-Force] [-CheckOnly]

# Gallery & Preview
forgum gallery [-Count <int>]
forgum preview <cow> "<text>"

# Settings Toggles
forgum toggle          # Toggles lolcat
forgum animate <mode>  # Sets animation
forgum eyes <preset|custom> # Sets eyes

Note: The forgum keyword uses Parameter Sets to ensure full native integration with Get-Help forgum and terminal tab-completion.

forgum

Generates an ASCII art cow saying the provided text.

Parameters

  • -Text ([string]): The message the cow will say. Required.
  • -Cow ([string]): The name of the cow to use (e.g., default, tux, dragon). Default: default.
  • -Eyes ([string]): Custom eye characters (must be exactly 2 characters). Default: oo.
  • -Tongue ([string]): Custom tongue characters (must be exactly 2 characters). Default: .
  • -Thoughts ([string]): The thought bubble character (usually \ or o). Default: \.
  • -Wrap ([int]): Column width to wrap the text. Default: 40.

Examples

# Basic usage
forgum -Text "Hello, World!"

# Using a different cow and custom eyes
forgum -Text "I am a Linux penguin" -Cow "tux" -Eyes "=="

forgum

The main entry point for the combined Forgum experience (Fortune + Cowsay + Lolcat).

Parameters

  • -Lolcat ([switch]): Apply rainbow colors to the output.
  • -Animation ([string]): Specify an animation mode (e.g., scroll, fade).
  • -Text ([string]): Override the fortune with custom text.
  • -Cow ([string]): The name of the cow to use. If not specified, uses the configured default or randomizes.

Examples

# Default behavior (Random fortune + Default cow)
forgum

# Rainbow colored fortune with a specific cow
forgum -Lolcat -Cow "dragon"

# Custom text with rainbow colors
forgum -Text "Stay awesome!" -Lolcat

Get-Fortune

Retrieves a random fortune from the internal database.

Parameters

None.

Examples

# Get a single fortune
Get-Fortune

Get-CFCow

Lists available ASCII cows or retrieves the raw template for a specific cow.

Parameters

  • -Name ([string]): The specific cow name to retrieve. If omitted, returns a list of all available cow names.

Examples

# List all cows
Get-CFCow

# Get raw template for 'ghost'
Get-CFCow -Name "ghost"

Set-Forgum

The easiest way to update your Forgum configuration persistently.

Parameters

  • -Animation ([string]): Sets the animation mode. (e.g. static, talking, typewriter, bounce, etc.)
  • -Cow ([string]): Sets the default cow character.
  • -Eyes ([string]): Sets the default eye character for the cow.
  • -Lolcat ([bool]): Enables or disables rainbow colorization globally.
  • -RandomCow ([bool]): Enables or disables random cow selection on startup.
  • -RainbowFrequency ([double]): Adjusts the frequency of rainbow colors (0.01 to 1.0).

Examples

# Set dragon as default cow with talking animation
Set-Forgum -Cow dragon -Animation talking

# Enable lolcat and set eyes to 'XX'
Set-Forgum -Lolcat $true -Eyes "XX"

Get-CFConfig

Retrieves the current Forgum configuration settings.

Parameters

None.

Examples

# Display current configuration
$config = Get-CFConfig
$config.DefaultCow

Set-CFConfig

Updates the Forgum configuration.

Parameters

  • -Config ([hashtable]): A hashtable containing the configuration keys and values to update. Required.

Examples

# Change the default cow and enable Lolcat globally
$newConfig = @{ DefaultCow = "tux"; EnableLolcat = $true }
Set-CFConfig -Config $newConfig

Show-CFAnimation

Applies an animation effect to the provided text.

Parameters

  • -Text ([string]): The ASCII art or text to animate. Required.
  • -Mode ([string]): The animation style. Supported values depend on configuration (e.g., Scroll, Fade, Typewriter). Default: None.

Examples

# Scroll animation
$cowText = forgum -Text "Watch me move!"
Show-CFAnimation -Text $cowText -Mode "Scroll"

Helper Commands & Aliases

Forgum provides several structured helper commands (and shorter aliases) for everyday usage. All commands support standard PowerShell help features (e.g. \Get-Help cowgallery -Detailed\ or \cowgallery -?).

\Show-CFCowGallery\ (Alias: \cowgallery)

Displays a randomized gallery of cows with fortunes.

  • Parameters: -Count\ (default: 5)
  • Example: \cowgallery -Count 10\

\Show-CFCowPreview\ (Alias: \cowpreview)

Quickly preview what a specific cow looks like with a custom message.

  • Parameters: -CowFile\ (default: 'default'), -Text\ (default: 'Hello!')
  • Example: \cowpreview tux
    Linux rocks!\

\Show-CFConfig\ (Alias: \cowconfig)

Displays the current Forgum configuration in a formatted JSON layout.

  • Example: \cowconfig\

\Toggle-CFLolcat\ (Alias: \lolcat-toggle)

Instantly toggles the rainbow color mode on or off.

  • Example: \lolcat-toggle\

\Set-CFCowAnimate\ (Alias: \cow-animate)

Changes your globally configured animation mode.

  • Parameters: -Mode\ (e.g. 'static', 'physics', 'aurora', 'matrix')
  • Example: \cow-animate physics\

\Set-CFCowEyes\ (Alias: \cow-eyes)

Changes the default eyes of your cow.

  • Parameters: -Preset\ (e.g. 'borg', 'dead', 'greedy') or -Custom\
  • Example: \cow-eyes -Preset borg\ OR \cow-eyes @@\

\forgumTUI\ (Alias: \orgum-tui)

Opens an interactive, keyboard-navigable Terminal User Interface to tweak your settings visually. You can change animation modes, toggle lolcat, set default cows, and update your profile automatically.

  • Example: \orgum-tui\

Clone this wiki locally