Skip to main content

Your customizable codding assistant in your CLI

Project description

Code Pilot CLI

Continuous Integration Continuous Deployment Black Ruff

Your customizable coding assistant for the command line interface (CLI).

Demo

<iframe width="560" height="315" src="https://www.youtube.com/embed/XdwqzXIJ_qc?si=VpsC4GvZPW-S70r0" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

Getting Started

To begin, install the package:

pip install code-pilot-cli

Export your HF_TOKEN as an environment variable, you can get your token from HuggingFace:

Bash:

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

Powershell:

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

You are now ready to utilize the application.

Usage

To view the help options, run:

code-pilot --help

Generate Commands

You can generate shell commands using natural language:

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

Chat

Engage in a chat with CodePilot:

code-pilot chat --

# Export chat history
code-pilot chat -e chat-history.json

# Import chat history
code-pilot chat -h chat-history.json

# Import chat history and then export it after the session
code-pilot chat -h chat-history.json -e chat-history.json

Code Completions

Receive code completions from CodePilot:

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

Code Enhancements

Obtain suggestions from CodePilot for improving your code to adhere to best practices and industry standards:

code-pilot enhance app.py

Perform Code Scans

Check your code for potential security vulnerabilities:

code-pilot scan app.py

Custom Large Language Models (LLMs)

Utilize custom LLMs:

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

License

This project is licensed under the MIT License.

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

code_pilot_cli-0.1.9.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

code_pilot_cli-0.1.9-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file code_pilot_cli-0.1.9.tar.gz.

File metadata

  • Download URL: code_pilot_cli-0.1.9.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.8.0-1014-azure

File hashes

Hashes for code_pilot_cli-0.1.9.tar.gz
Algorithm Hash digest
SHA256 6f9231dc6fbfe4839ff1c42d5fe75153f1498d838822a36453f948946e6801d7
MD5 480006b45bd30e24233685fdbe0124bc
BLAKE2b-256 37b6ee92ad94bd76c9db7242e1256908b039d6f4ae1000ba63247ed717082354

See more details on using hashes here.

File details

Details for the file code_pilot_cli-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: code_pilot_cli-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 13.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.8.0-1014-azure

File hashes

Hashes for code_pilot_cli-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 b1e156e4254cc128fa7e218d7dd784eef7afdd10c94e982f0dd85fdc2320eb8f
MD5 5b4380aba1b27004f4c64bb4720c4d15
BLAKE2b-256 4a83659d1acbd594954b03bea0ea9368870037c2ddd8b49a77720468869bcc0a

See more details on using hashes here.

Supported by

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