An AI-powered CLI assistant that helps with coding and system tasks
Project description
Hey CLI
An AI-powered CLI assistant that helps with coding and system tasks.
Installation
From PyPI
pip install hey-cli
From Source (for development)
git clone https://github.com/Kawai-Senpai/hey-cli.git
cd hey-cli/library
pip install -e .
Configuration
Create a .env file in your working directory with your OpenAI API key:
OPENAI_API_KEY=your_api_key_here
AI_MODEL=gpt-4o # Optional, defaults to gpt-4o
AI_TEMPERATURE=0.1 # Optional, defaults to 0.1
Usage
After installation, you can use the hey command followed by your question or instruction:
# Ask for help
hey help me understand how to use this tool
# Create a simple script
hey create a hello world script in python
# Get system information
hey what files do I have in this directory?
# Create files for a project
hey create a new React component for a login form
Testing Locally
-
Install the package in development mode:
cd /path/to/hey-cli/library pip install -e .
-
Create a
.envfile in any directory where you want to use the tool:OPENAI_API_KEY=your_actual_openai_key_here -
Navigate to that directory and run commands:
cd /your/project/directory hey create a simple python script that prints the current date
-
Check that the tool:
- Creates a
.heydirectory for storing history - Correctly analyzes your directory
- Communicates with OpenAI
- Executes operations like creating files, etc.
- Creates a
Features
- Performs file operations (create, edit, delete)
- Executes shell commands
- Manages directories
- Answers questions about code and development
- Maintains conversation context
File Operations
Hey CLI can perform various file operations:
create_file: Create new files with contentedit_file: Modify existing filesdelete_file: Remove filesrename_file: Rename filescreate_directory: Create new directoriesdelete_directory: Remove directoriesexecute_command: Run shell commands
License
MIT License - See LICENSE.rst for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hey_python-1.0.0.tar.gz.
File metadata
- Download URL: hey_python-1.0.0.tar.gz
- Upload date:
- Size: 19.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8517089aa3dedd8c025bbd2f338425474278bed3c538546cc4ad9ef66cdcb351
|
|
| MD5 |
8c4415e000f711c4c1136ce25f43ada3
|
|
| BLAKE2b-256 |
dc248666986ab143789724669f686cde5e5fccff70c996caba299c88cce5eee0
|
File details
Details for the file hey_python-1.0.0-py3-none-any.whl.
File metadata
- Download URL: hey_python-1.0.0-py3-none-any.whl
- Upload date:
- Size: 22.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
134e1e10851ae2ed1e1689a5bd1d5c4a1e4b41683808f773c19e18639e8b981c
|
|
| MD5 |
db8b303ac157f2a22fcab5b4380eced8
|
|
| BLAKE2b-256 |
a22a9a4e911335704162c6b09c2e64b1c776c568c31bb030b4aaf42a9e899423
|