Penify-CLI Documentation

Welcome to the official documentation for Penify-CLI, your AI-powered assistant for code documentation and Git commit management.

What is Penify-CLI?

Penify-CLI is a powerful command-line tool designed to streamline your development workflow. It uses advanced AI to automate code documentation and generate meaningful Git commit summaries.

Key Features

1. Commit Summary Generation: Automatically create informative Git commit messages.
2. File Documentation: Generate comprehensive documentation for individual code files.
3. Repository Documentation: Create documentation for entire code repositories.
4. Git Changes Documentation: Document recent changes in your Git repository.
5. Post-Commit Hooks: Install and manage Git post-commit hooks for automated workflows.

Installation

To install Penify-CLI, run the following command:

pip install penify-cli

Login

Login to Penify

penify-cli login

Quick Start

Here's a quick example to generate a commit summary:

cd /path/to/your/repo
penify-cli commit

For more detailed information on each feature, please refer to the specific documentation pages linked above.

Support

If you encounter any issues or have questions, please visit our GitHub Issues page or contact our support team at support@penify.dev.

Happy coding with Penify-CLI!