code-pilot-cli 0.2.0

Your customizable codding assistant in your CLI

CodePilot CLI

A powerful and customizable code assistant designed for the command line interface (CLI) to help developers automate various coding tasks.

Interactive Demonstration

We have created a short interactive demonstration on how to use the CodePilot CLI, showcasing its features.

Getting Started

To use the CodePilot CLI, you'll need to first install the package using pip:

pip install code-pilot-cli

Next, make sure to export your Hugging Face HF_TOKEN as an environment variable. You can obtain your token from Hugging Face's website.

For Bash:

export HF_TOKEN=hf_**********************************

For PowerShell:

$env:HF_TOKEN = "hf_**********************************"

Now you are all set to start using the CodePilot CLI!

Usage

Access Help Options

To view available help options, run:

code-pilot --help

Interact with CodePilot

Engage with CodePilot by providing prompts:

code-pilot ai 'list all files in the current directory'

Chat with CodePilot

Initiate a conversation with CodePilot and export or import the chat history for future reference:

code-pilot chat --

Generate Code Completions

Obtain code completions from CodePilot based on the user's input:

code-pilot completions 'fn add(x: i32, y: i32) -> i32 {'

Generate Documentation

Generate code documentation directly from source files:

code-pilot document src/main.rs

Enhance Code Quality and Best Practices

Get suggestions on how to improve your code according to best practices:

code-pilot enhance App.tsx

Perform Code Review

Perform a code review using CodePilot model and receive valuable feedback:

code-pilot review app/models.py

Perform Code Scanning

Scan your code for potential security vulnerabilities:

code-pilot scan src/main.rs

Generate Tests

Automatically generate tests based on your source code:

code-pilot test src/lib.rs

Use Custom Large Language Models (LLMs)

Leverage custom LLMs for enhanced code assistants:

code-pilot chat -m'mistralai/Mistral-Nemo-Instruct-2407'

License

The CodePilot CLI project is released under the MIT License.