https://github.com/dylanjcastillo/shell-genie Skip to content Toggle navigation Sign up * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code + Explore + All features + Documentation + GitHub Skills + Blog * Solutions + For + Enterprise + Teams + Startups + Education + By Solution + CI/CD & Automation + DevOps + DevSecOps + Case Studies + Customer Stories + Resources * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles + Repositories + Topics + Trending + Collections * Pricing [ ] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this user All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up {{ message }} dylanjcastillo / shell-genie Public * Notifications * Fork 1 * Star 59 Your wishes are my commands 59 stars 1 fork Star Notifications * Code * Issues 1 * Pull requests 0 * Actions * Projects 0 * Security * Insights More * Code * Issues * Pull requests * Actions * Projects * Security * Insights dylanjcastillo/shell-genie This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. main Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags Name already in use A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch? Cancel Create 1 branch 0 tags Code * Local * Codespaces * Clone HTTPS GitHub CLI [https://github.com/d] Use Git or checkout with SVN using the web URL. [gh repo clone dylanj] Work fast with our official CLI. Learn more. * Open with GitHub Desktop * Download ZIP Sign In Required Please sign in to use Codespaces. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching Xcode If nothing happens, download Xcode and try again. Launching Visual Studio Code Your codespace will open once ready. There was a problem preparing your codespace, please try again. Latest commit @dylanjcastillo dylanjcastillo Add missing base class ... d6da42a Jan 27, 2023 Add missing base class d6da42a Git stats * 34 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time shell_genie Add missing base class Jan 27, 2023 tests Remove tests Jan 25, 2023 .gitattributes Initial commit Jan 22, 2023 .gitignore Fix post_execute Jan 25, 2023 README.md Fixed typo Jan 27, 2023 poetry.lock Refactor code Jan 25, 2023 pyproject.toml Update project description Jan 27, 2023 View code [?] Shell Genie Installation How to use Examples Limitations README.md [?] Shell Genie Your wishes are my commands. Shell Genie is a command-line tool that lets you interact with the terminal in plain English. You ask the genie what you want to do and it will give you the command you need. Installation The recommended way to install Shell Genie is using pipx: 1. Install Python 3.10 or higher. 2. Install pipx. 3. Install Shell Genie: pipx install shell-genie Alternatively, you can install it using pip: 1. Install Python 3.10 or higher. 2. Create a virtual environment in your preferred location: python -m venv .venv 3. Activate the virtual environment: source .venv/bin/activate 4. Install Shell Genie: pip install shell-genie How to use 1. First, you need to initialize the tool by running the following command: shell-genie init This will prompt you to select a backend (either openai-gpt3 or free-genie) and provide any additional information that is required (e.g. your own OpenAI API key for openai-gpt3). The free-genie backend is free to use. I'm hosting it, and as you can imagine I'm not a big corporation with unlimited money, so there's no guarantee that it will be available at all times. My goal is to generate a dataset of commands to fine-tune a model later on (this is mentioned during the initialization process). 2. Once you have initialized the tool, you can start asking the genie what you want to do. For example, you may ask it to find all the json files in the current directory that are larger than 1MB: shell-genie ask "find all json files in the current directory that are larger than 1MB" You'll see an output similar to this: Command: find . -name "*.json" -size +1M Do you want to run this command? [y/n]: If you have questions about how the command works, you can ask the genie to explain it: shell-genie ask "find all json files in the current directory that are larger than 1MB" --explain And you'll see an output similar to this: Command: find . -name "*.json" -size +1M Description: This command will search the current directory for all... (shortened for brevity) Do you want to run the command? [y/n]: 3. Run the command if you want to. If you're using free-genie, and you want to help improve the tool, you can provide feedback after you've run the command. Examples Here are two short videos showing how to use the tool: * Ask genie for a command * Ask genie to explain a command Limitations As you can imagine not all the commands provided by the genie work as expected. Use them at your own risk. About Your wishes are my commands Resources Readme Stars 59 stars Watchers 2 watching Forks 1 fork Releases No releases published Packages 0 No packages published Languages * Python 100.0% Footer (c) 2023 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.