Skip to main content

CodeStar is an advanced AI-powered coding assistant designed to enhance developer productivity by providing intelligent code suggestions and natural language interactions. Built on Hugging Face's StarCoder 2 (15B) and StarChat 2 15B.

Project description

CodeStar CLI: AI-Powered Development Guide and Productivity Enhancement

CI CD Black Ruff

Welcome to the world of CodeStar, a cutting-edge AI-powered development tool designed to enhance your programming efficiency and productivity. By harnessing the power of StarCoder 2, a state-of-the-art LLM for code, CodeStar provides unparalleled assistance in various coding tasks, including AI-powered code completions, natural language processing, multi-language support, and seamless integration.

Key features of CodeStar include:

  • Superior code completions: Receive precise and contextually relevant suggestions, allowing you to write code faster with fewer errors.
  • Natural language understanding: Interact with CodeStar using natural language, enabling explanations, debugging tips, and guidance tailored to your specific needs.
  • Multi-language support: Effortlessly write and run code in over 100 programming languages with CodeStar's seamless integration support.
  • Learning from usage data: Make every interaction more personalized by continuously learning from your coding habits, ensuring that you always receive relevant and timely insights.

With CodeStar, you can unlock new worlds of possibilities for coding efficiency, faster response times, and greater intuitiveness. Your drive for better software development can be rewarded with increased productivity, reduced debugging time, and enhanced code quality.

Installation

To install CodeStar CLI, use pip:

pip install code-star-cli

After installation, make sure to export your HF_TOKEN as an environment variable. Your token can be found in HuggingFace's Settings page:

shell:

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

Powershell:

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

Now, you're ready to start using CodeStar's rich suite of features to enhance your coding experience.

Usage Instructions

Command Reference

To view the usage instructions and command reference, use:

code-star --help

Prompt AI-Powered Code Completions

To get AI-powered code completions for your coding journey:

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

Start an Interactive Chat

CodeStar also offers an interactive chat experience, allowing you to engage in semi-structured conversations:

code-star chat --

To export your chat history:

code-star chat -e chat-history.json

To import a chat history:

code-star chat -h chat-history.json

Perform both import and export actions:

code-star chat -h chat-history.json -e chat-history.json

Generate Code Completions Based on Code Snippets

Need assistance with completing your code snippet? CodeStar can help:

code-star completions 'def hello_world():'
code-star completions -l python 'def hello_world():'

Generate Code Documentation

To improve your code readability and maintainability, generate documentation using CodeStar:

code-star document code.py

Enhance Code Quality and Best Practices

Apply best practices and enhancements suggested by CodeStar:

code-star enhance code.py

Perform Code Reviews

CodeStar can guide you through code reviews, highlighting potential improvements and adhering to coding standards:

code-star review code.py

Scan for Security Vulnerabilities

Take a deep dive into finding and fixing vulnerabilities in your code:

code-star scan code.py

Generate Tests

Create unit tests and integration tests to verify the correctness of your code:

code-star test code.py

License

CodeStar CLI 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_star_cli-0.2.2.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

code_star_cli-0.2.2-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file code_star_cli-0.2.2.tar.gz.

File metadata

  • Download URL: code_star_cli-0.2.2.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.8.0-1015-azure

File hashes

Hashes for code_star_cli-0.2.2.tar.gz
Algorithm Hash digest
SHA256 811f6aed271c77573400799b2c98a6d753e56106791b76dee127d846513cb5ec
MD5 cedad7690e56526fa59e33aa77ae048a
BLAKE2b-256 5e1d762e40f7fcca5bb82e71b019628888a7518f4a3244d28e99689319564f17

See more details on using hashes here.

File details

Details for the file code_star_cli-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: code_star_cli-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.8.0-1015-azure

File hashes

Hashes for code_star_cli-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ae86a3b054670a2b35e6271199add239507a45fd66bdd237cc2ebacdef2ae8c3
MD5 881c893ea96a984792aa0a23561a6053
BLAKE2b-256 c4d4689ad28d72feb506ef92eb388b0d4fb6f72c8fedb12bb31312802c5833b1

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