Penify-CLI Documentation

Penify CLI is a tool that enhances your development workflow with AI-powered capabilities:

• Generate smart commit messages using local LLM models or cloud API
• Automatically create code documentation
• Integrate with JIRA for enhanced commit messages
• Install Git hooks for automated documentation generation

Installation

pip install penify

Authentication

Penify CLI supports two authentication methods:

1. Login to Penify Account (Required for Advanced Features)

penify login

This command will open your browser and prompt you to log in to your Penify account. Once authenticated, your API token will be saved locally.

2. Environment Variable

For CI/CD pipelines or automated environments, you can set:

export PENIFY_API_TOKEN=your_api_token

Basic Usage

Generate Smart Commit Messages

penify commit

Generate Code Documentation

# Generate documentation for current Git diff (requires login)
penify docgen

# Generate documentation for a specific file
penify docgen -l path/to/file.py

# Generate documentation for a folder
penify docgen -l path/to/folder

Configure Local LLM or JIRA

# Configure Local LLM for commit message generation
penify config llm

# Configure JIRA integration
penify config jira

Automate Documentation with Git Hooks

# Install a post-commit hook
penify docgen install-hook

# Remove the hook
penify docgen uninstall-hook

Getting Help

# Get general help
penify --help

# Get help for a specific command
penify commit --help
penify docgen --help
penify config --help

For detailed documentation and examples, see docs/detailed-usage.md.