Skip to main content

AI-powered CLI assistant for developers: commits, summaries, PR reviews, docs.

Project description

Agenzic

Agenzic is a terminal-based AI assistant for developers. It streamlines developer workflows by providing AI-powered commit messages, code/file summarization, pull request reviews, documentation generation, and unit test suggestions — all from the command line.


Features

  • AI Commit Assistant Generate clean, conventional commit messages from staged Git changes. Supports multiple options and allows editing before committing.

  • Code/File Summarizer Summarize files or entire codebases to quickly understand legacy code or onboard new developers.

  • AI PR / Code Reviewer Review staged Git changes or specific code files. Provides suggestions for security, style, and possible bugs.

  • Documentation Generator Generate docstrings or README drafts for individual files or entire projects.

  • Test Case Generator Suggest unit tests for your functions based on code content.

  • Version & Environment Info Quickly display the current version of Agenzic along with relevant environment information.

  • Help & Usage Guidance Built-in help command provides a concise overview of commands and usage examples.


Installation

pip install agenzic

Note: Agenzic requires an OpenAI API key. Set it as an environment variable:

export OPENAI_API_KEY="your_api_key_here"

Or, if using a .env file:

OPENAI_API_KEY=your_api_key_here

Usage

# Generate AI commit messages for staged changes
agenzic commit

# Summarize a file
agenzic summarize myscript.py

# Review staged changes or a specific file
agenzic review
agenzic review --file utils/helpers.py

# Generate documentation
agenzic docgen --file myscript.py
agenzic docgen --dir src/

# Generate unit tests for a file
agenzic tests myscript.py

# Show version and environment info
agenzic version

# Show project information
agenzic about

# Display help
agenzic help

Project Structure

agenzic/
├── agenzic/                # Python package
│   ├── __init__.py
│   ├── __main__.py         # CLI entrypoint
│   ├── commands/           # Individual commands (commit, summarize, review, etc.)
│   └── utils/              # Utility functions (API key, helpers)
├── pyproject.toml           # Project configuration
├── README.md               # This file
└── LICENSE                 # License file

License

Agenzic is licensed under the MIT License.


Contributing

Contributions are welcome!

  • Fork the repository
  • Create a feature branch (git checkout -b feature/my-feature)
  • Commit your changes (git commit -am 'Add feature')
  • Push to the branch (git push origin feature/my-feature)
  • Open a Pull Request

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agenzic-0.1.0.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agenzic-0.1.0-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file agenzic-0.1.0.tar.gz.

File metadata

  • Download URL: agenzic-0.1.0.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for agenzic-0.1.0.tar.gz
Algorithm Hash digest
SHA256 39d4706e9dbbd78d7ffa2d05f697edd230639c028cffceb42bd67394323426e9
MD5 b750a31b22343026206fd2d679538968
BLAKE2b-256 755a5a45702ff633ca297dc12806f9af81d1fa7f8d3e62edad5419812c7b1a76

See more details on using hashes here.

File details

Details for the file agenzic-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: agenzic-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for agenzic-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8de977d8fe53d64a65fc34d3b44e97fd0c71a860cf573c0e83fcf0e9b4486797
MD5 d4cdd88d58821b268796a692294cfbc1
BLAKE2b-256 66368caf7e6de21d3038c870d2868ed49f3b00b98f988a36078774e38c6c14c0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page