CLI Commands

/**
 * Main CLI Entry Point - processes command line arguments and starts interactive commit
 * @param environment - Optional environment configuration object
 * @param argv - Command line arguments array (defaults to process.argv)
 */
function main(environment?: any, argv?: string[]): void;

# Basic usage - starts interactive commit process
czg

# With specific git arguments passed through
czg --amend
czg --no-verify

/**
 * Start inquirer prompts to generate commit message
 * @param version - Current czg version string
 * @param argvs - Parsed CLI arguments structure
 * @param environment - Optional environment configuration
 */
function czg(version: string, argvs: CzgitParseArgs, environment?: any): void;

/**
 * Parse CLI arguments using minimist into structured format
 * @param argv - Raw command line arguments
 * @returns Structured parsed arguments with czg and git sections
 */
function resovleArgs(argv: string[]): CzgitParseArgs;

# Basic AI mode
czg ai

# AI mode with multiple suggestions
czg ai -N=3

# AI mode with specific model
czg ai -M="gpt-4o"

# Combined AI options
czg ai -N=5 -M="gpt-3.5-turbo"

czg emoji

czg checkbox

czg break

czg gpg

czg init

# Use specific configuration file
czg --config="./config/cz.json"
czg --config="/path/to/custom.config.js"

# Direct commit with predefined alias
czg --alias="feat: add new feature"
czg :feat  # Shorthand alias syntax

# Set OpenAI API key
czg --api-key="sk-xxx"

# Configure API model
czg --api-model="gpt-4o"

# Set API endpoint
czg --api-endpoint="https://api.openai.com/v1"

# Configure proxy
czg --api-proxy="http://proxy.example.com:8080"

# Remove proxy configuration
czg --unset-proxy

# Disable AI for this session
czg --no-ai

# AI options for current session
czg -N=3 -M="gpt-4o"  # 3 suggestions, gpt-4o model

# Retry last commit attempt
czg --retry
czg -r

# Hook mode (for git hooks integration)
czg --hook

# Reback last commit (not implemented)
czg --reback
czg -b

# Show help information
czg --help
czg -h

# Show version
czg --version
czg -v

# These git flags are passed through to git commit
czg --amend
czg --no-verify
czg --author="John Doe <john@example.com>"
czg -a  # Stage all files before commit
czg --allow-empty

/**
 * Check if git working directory is clean
 * @param repoPath - Path to git repository
 * @param done - Callback function receiving (error, isClean)
 * @param stageAllFiles - Whether to check for unstaged files too
 */
function isGitClean(repoPath: string, done: CallBackFn, stageAllFiles: boolean): void;

/**
 * Get the root path of the current git repository
 * @returns Git repository root path
 */
function getGitRootPath(): string;

/**
 * Get the absolute path to the .git directory
 * @param pwd - Current working directory
 * @returns Absolute path to .git directory
 */
function getGitDirPath(pwd: string): string;

/**
 * Execute git commit with the provided message and options
 * @param repoPath - Path to git repository
 * @param message - Commit message to use
 * @param options - Commit configuration options
 * @param done - Callback function for completion
 */
function gitCommit(repoPath: string, message: string, options: CommitOptions, done: CallBackFn): void;

/**
 * Generate and display help documentation
 * @param version - Current czg version
 * @param code - Exit code (default: 0)
 */
function generateHelp(version: string, code?: number): void;

/**
 * Setup OpenAI API configuration in user's home directory
 * @param token - OpenAI API token/key
 * @param apiProxy - API proxy URL
 * @param unsetProxy - Whether to remove proxy configuration
 * @param apiEndpoint - Custom API endpoint
 * @param apiModel - Default AI model to use
 */
function setupAIConfig(
  token?: string,
  apiProxy?: string,
  unsetProxy?: boolean,
  apiEndpoint?: string,
  apiModel?: string
): void;

{
  "openAIToken": "sk-xxx",
  "apiProxy": "http://proxy.example.com:8080",
  "apiEndpoint": "https://api.openai.com/v1",
  "apiModel": "gpt-4o"
}