Shell copilot - sh shell AI copilot
Project description
Shy.sh
Sh shell AI copilot
Install
pip install shy-sh
Configure your LLM
shy --configure
Supported providers: openai, anthropic, google, groq, aws, ollama
Help
Usage: shy [OPTIONS] [PROMPT]...
Arguments prompt [PROMPT]
Options
- -x Do not ask confirmation before executing scripts
- -e Explain the given shell command
- --configure Configure LLM
- --push-config $name Backup current config
- --pull-config $name Restore config from backup
- --list-configs List available configs
- --del-config $name Delete a config
- --help Show this message and exit.
Settings
shy --configure
Provider: ollama
Model: llama3.2
Agent Pattern: flow
Temperature: 0.0
Language: klingon
Sandbox Mode: Yes
Configurable settings
- Provider: The LLM provider to use [OpenAI, Anthropic, Google, Groq, AWS Bedrock, Ollama(local)].
- API Key: The API key for the LLM provider. (Format for aws bedrock:
region_name acces_key secret_key) - Model: The LLM model to use.
- Agent Pattern: flow or react or function_call. It defines how the agent will interact with the LLM.
- Temperature: The LLM model's temperature setting.
- Language: The language for the LLM's final answers.
- Sandbox Mode: When enabled, no commands or scripts will be executed on your system; you will only receive suggestions. This feature is recommended for beginners.
All the settings are saved in ~/.config/shy/config.yml
Examples
> shy find all python files in this folder
🛠️ find . -type f -name '*.py'
Do you want to execute this command? [Yes/no/copy/explain/alternatives]:
./src/chat_models.py
./src/agent/tools.py
./src/agent/__init__.py
./src/agent/agent.py
./src/settings.py
./src/main.py
🤖: Here are all the Python files found in the current folder and its subfolders.
> shy -x convert aaa.png to jpeg and resize to 200x200
🛠️ convert aaa.png -resize 200x200 aaa.jpg
🤖: I converted the file aaa.png to JPEG format and resized it to 200x200 pixels.
> shy resize movie.avi to 1024x768 and save it in mp4
🛠️ ffmpeg -i movie.avi -vf scale=1024:768 -c:v libx264 output.mp4
Do you want to execute this command? [Yes/no/copy/explain/alternatives]: c
🤖: Command copied to the clipboard!
> shy
✨: Hello, how are you?
🤖: Hello! I'm fine thanks
✨: how many files in this folder
🛠️ ls | wc -l
Do you want to execute this command? [Yes/no/copy/explain/alternatives]:
5
✨: exit
🤖: 👋 Bye!
> shy -e "find . -type f -name '*.py' | wc -l"
🤖: This shell command uses `find` to search for files (`-type f`) with the extension `.py` (`-name '*.py'`) in the current directory (`.`) and its subdirectories.
The results are then piped to `wc -l`, which counts the number of line.
In conclusion, the command presents the total count of Python files (*.py) located within the current directory and its subdirectories.
Chat commands
You can use these commands during the chat:
/chatsto list all the chats/clearto clear the current chat/historyto list the recent executed commands/scripts/load [CHAT_ID]to continue a previous chat
Privacy
If you are not using Ollama as provider, please note that information such as the current path, your operating system name, and the last commands executed in the shell may be included in the LLM context.
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 shy_sh-1.3.2.tar.gz.
File metadata
- Download URL: shy_sh-1.3.2.tar.gz
- Upload date:
- Size: 23.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.11.13 Linux/6.11.0-1015-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ee6bb1be4dbcd3e534e0f1909e8516cbf3859ea2ab7805d516b8793b05157101
|
|
| MD5 |
124901fc8c94610a880a03c9b288c8ab
|
|
| BLAKE2b-256 |
967382cba1015308dddeacc6f7d318a6c059523c7b334f980372b6c920e673aa
|
File details
Details for the file shy_sh-1.3.2-py3-none-any.whl.
File metadata
- Download URL: shy_sh-1.3.2-py3-none-any.whl
- Upload date:
- Size: 34.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.11.13 Linux/6.11.0-1015-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
72402c49e2f78975b6e7634715add21de49fe7d52b44285f3d78b1712ee6cf4d
|
|
| MD5 |
200ca89735d310a4da2ecebd9da2aa94
|
|
| BLAKE2b-256 |
58ef153e76915a1765143f37c7fa6cafabbd03af5a83497560db8eed64b6ca26
|