Neura Market
Shell Genie logo

Shell Genie

Free

Interact with the terminal in plain English.

FreeFree tier
Inputs: textOutputs: text
Type
Open Source
Visit Website GitHub (40 stars)

About Shell Genie

Shell Genie is an open-source command-line tool that translates natural language requests into shell commands. Users describe what they want to do in plain English (or other languages), and the tool returns the appropriate command, optionally with an explanation. It supports two backends: OpenAI's GPT-3.5 Turbo (requires an API key) and a free, community-hosted 'free-genie' backend. The project was archived in March 2024 and is no longer maintained; its author recommends considering alternatives like shellGPT. Despite being archived, the tool remains functional and can be installed via pipx or pip. It includes features such as command explanation, alias support, and feedback collection for the free backend to improve the model.

Key Features

Natural language to shell command conversion
Command explanation with --explain flag
Multiple backends: OpenAI GPT-3.5 Turbo and free-genie
Free-to-use community-hosted backend
Alias support for shorter commands (e.g., 'please' command)
Open-source codebase (MIT license)
Supports multiple languages for commands and explanations
Feedback collection to improve the free backend

Pros & Cons

Pros
  • Free backend available without requiring an API key
  • Command explanation helps users understand the generated command
  • Easy installation via pipx or pip in a virtual environment
  • Open-source and extensible (MIT license)
  • Alias support reduces typing overhead
  • Supports multiple human languages for input and output
Cons
  • Repository archived and no longer maintained (as of March 2024)
  • Commands may be incorrect or dangerous (e.g., could corrupt the OS)
  • Free backend availability is not guaranteed (limited funding)
  • Requires Python 3.10 or higher
  • Relies on external API for OpenAI backend (API key needed)

Best For

Find files by type and size (e.g., 'find all json files larger than 1MB')Perform system administration tasks without remembering exact syntaxLearn shell commands by seeing explanations before executionAutomate repetitive file operations and searchesAssist users transitioning from GUI to command line

FAQ

How do I install Shell Genie?
The recommended method is using pipx: 'pipx install shell-genie'. Alternatively, create a Python virtual environment and run 'pip install shell-genie'. Requires Python 3.10 or higher.
How do I start using Shell Genie?
Run 'shell-genie init' to choose a backend (openai-gpt3.5-turbo or free-genie) and provide any required API key. Then use 'shell-genie ask "your request"' to get a command.
What backends are available?
Two backends: 'openai-gpt3.5-turbo' (requires your OpenAI API key) and 'free-genie' (community-hosted, free but not guaranteed availability).
Can I get an explanation of the command?
Yes, add the '--explain' flag to your request: 'shell-genie ask "your request" --explain'. The genie will show the command and a description of how it works.
Is there a way to shorten the shell-genie command?
Yes, you can create an alias. For example: 'alias please="shell-genie ask"' then use 'please "your request"'.
Is Shell Genie still actively maintained?
No, the repository was archived by the owner on March 4, 2024, and is now read-only. The author recommends considering alternatives such as shellGPT.