Skip to main content

CodeIQ: A Next-Generation AI-Powered Development Assistant

CI CD Black Ruff PyPI - Version PyPI - Python Version PyPI - Downloads PyPI - Format PyPI - Implementation PyPI - License

Overview

CodeIQ is an advanced AI-powered command-line interface (CLI) tool designed to enhance coding efficiency and productivity. Utilizing the sophisticated capabilities of Qwen2.5-Coder-32B-Instruct, CodeIQ offers intelligent code completions, error detection, and automated coding functionalities. This empowers developers to streamline their workflows with precision and ease, making it an invaluable resource for professionals at all levels.

Key Features

  • Contextual Code Completions: Receive accurate, contextually relevant code suggestions to accelerate development with minimal errors.
  • Natural Language Interaction: Engage with CodeIQ using natural language for detailed explanations, debugging tips, and guidance.
  • Multi-Language Support: Seamlessly write and execute code in over 100 programming languages with CodeIQ's comprehensive integration.
  • Personalized Learning: Continuously improve recommendations based on user interactions, providing personalized and immediate insights.

Getting Started

Prerequisites

  • Python: CodeIQ requires Python 3.10 or higher. Ensure you have the correct version installed.
  • Hugging Face Token: Create an account on Hugging Face and obtain an API token.

Installation

To install CodeIQ, execute the following command:

pip install code-iq

Ensure that your Hugging Face token is set as an environment variable:

  • Unix-based Systems (Linux, macOS):

    export HF_TOKEN=hf_your_token_here
    
  • Windows (PowerShell):

    $env:HF_TOKEN = "hf_your_token_here"
    

Usage

Launch CodeIQ with the following command:

code-iq [OPTIONS] COMMAND [ARGS]...

Options

  • --install-completion: Install shell completion for CodeIQ.
  • --show-completion: Display the completion script for the current shell.
  • --help: Display this help message and exit.

Commands

  • ai: Utilize AI-driven functionalities to generate code, obtain explanations, and perform tasks.
  • chat: Enable real-time conversations for troubleshooting, guidance, and inquiries.
  • complete: Receive code completion suggestions based on context and best practices.
  • document: Assist in generating and formatting documentation.
  • enhance: Apply optimizations or improvements to code.
  • review: Conduct thorough code reviews for quality and adherence to standards.
  • scan: Identify vulnerabilities and potential issues within codebases.
  • test: Facilitate the creation and execution of tests.

code-iq ai

Leverage AI functionalities to generate code snippets, obtain suggestions, and perform tasks.

Examples:

code-iq ai "Generate a function to calculate the area of a circle"
code-iq ai -c code.py "Explain the code"
code-iq ai -o output.md "How to install HuggingFace Transformers?"

Usage:

code-iq ai [OPTIONS] PROMPT

Arguments:

  • PROMPT: The prompt or instruction for the AI. [required]

Options:

  • -c, --code FILENAME: Include a code file in the prompt.
  • -o, --output FILENAME: Write the response to this file.
  • -t, --max-tokens INTEGER: Limit the number of tokens in the response. [Default: 2048]
  • --help: Display this help message and exit.

code-iq chat

Engage in real-time conversations for troubleshooting, guidance, or general inquiries.

Examples:

# Start a chat session
code-iq chat

# Export chat history
code-iq chat -e chat_history.json

# Import chat history
code-iq chat -h chat_history.json

# Import chat history and export after session
code-iq chat -h chat_history.json -e chat_history.json

Usage:

code-iq chat [OPTIONS]

Options:

  • -e, --export FILENAME: Export the chat history to this file.
  • -h, --history FILENAME: Import a previous chat history from this file.
  • -t, --max-tokens INTEGER: Limit the number of tokens in the response. [Default: 2048]
  • --help: Display this help message and exit.

code-iq complete

Receive suggestions to complete partially written code based on context and best practices.

Examples:

code-iq complete 'def hello_world():'
code-iq complete -l python 'def hello_world():'
code-iq complete -o code-completions.md 'def hello_world():'

Usage:

code-iq complete [OPTIONS] CODE

Arguments:

  • CODE: The code snippet for which to receive completions. [required]

Options:

  • -l, --lang TEXT: Specify the programming language of the code snippet.
  • -o, --output FILENAME: Write the response to this file.
  • -t, --max-tokens INTEGER: Limit the number of tokens in the response. [Default: 128]
  • --help: Display this help message and exit.

code-iq document

Generate and manage code documentation, including comments, README files, and technical documentation.

Examples:

code-iq document code.py
code-iq document code.py -o code-docs.md

Usage:

code-iq document [OPTIONS] CODE

Arguments:

  • CODE: The code file for which to generate documentation. [required]

Options:

  • -o, --output FILENAME: Write the response to this file.
  • -t, --max-tokens INTEGER: Limit the number of tokens in the response. [Default: 2048]
  • --help: Display this help message and exit.

code-iq enhance

Apply improvements or optimizations to existing code, including refactoring and performance tuning.

Examples:

code-iq enhance code.py
code-iq enhance code.py -o code-enhancements.md

Usage:

code-iq enhance [OPTIONS] CODE

Arguments:

  • CODE: The code file to enhance. [required]

Options:

  • -o, --output FILENAME: Write the response to this file.
  • -t, --max-tokens INTEGER: Limit the number of tokens in the response. [Default: 2048]
  • --help: Display this help message and exit.

code-iq review

Analyze code for potential issues and adherence to coding standards.

Examples:

code-iq review code.py
code-iq review code.py -o code-review.md

Usage:

code-iq review [OPTIONS] CODE

Arguments:

  • CODE: The code file to review. [required]

Options:

  • -o, --output FILENAME: Write the response to this file.
  • -t, --max-tokens INTEGER: Limit the number of tokens in the response. [Default: 2048]
  • --help: Display this help message and exit.

code-iq scan

Identify vulnerabilities, bugs, or areas for improvement within codebases.

Examples:

code-iq scan code.py
code-iq scan code.py -o code-scan.md

Usage:

code-iq scan [OPTIONS] CODE

Arguments:

  • CODE: The code file to scan. [required]

Options:

  • -o, --output FILENAME: Write the response to this file.
  • -t, --max-tokens INTEGER: Limit the number

Metadata

Release files for code-iq 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for code-iq 1.0.1
File Size Uploaded
code_iq-1.0.1.tar.gz 10.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for code-iq 1.0.1
File Interpreter ABI Platform
code_iq-1.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 25.9 kB

Release files / code_iq-1.0.1.tar.gz

Download URL code_iq-1.0.1.tar.gz
Size 10.2 kB
Tags Source
SHA-256 checksum
How to use checksums
feaf5ec14c4d95a85171d9701210153ca11c183c9fbc8a0128d583ef01674255
BLAKE2b-256 checksum
How to use checksums
31721601ac5a554a0b8d5ebfb937488d6af1724fad9cb4c446d6cb8886167ab1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.5 CPython/3.12.3 Linux/6.8.0-1017-azure

Release files / code_iq-1.0.1-py3-none-any.whl

Download URL code_iq-1.0.1-py3-none-any.whl
Size 15.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f6ecfd1eee545374955bbb1224b58cd6cf9967a854a221f65a40dd8e16ab4672
BLAKE2b-256 checksum
How to use checksums
4ff66339e8cee8d59ddf730191abcf171bb64bca1dfd98e3074e487d73245b78
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.5 CPython/3.12.3 Linux/6.8.0-1017-azure

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files

1.0.0

2 release files

0.2.4

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page