{"id":14964972,"url":"https://github.com/djcopley/shelloracle","last_synced_at":"2025-04-08T16:00:19.120Z","repository":{"id":211981902,"uuid":"730389199","full_name":"djcopley/ShellOracle","owner":"djcopley","description":"A terminal utility for intelligent shell command generation","archived":false,"fork":false,"pushed_at":"2025-03-23T20:06:32.000Z","size":1791,"stargazers_count":256,"open_issues_count":4,"forks_count":17,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-01T14:01:51.831Z","etag":null,"topics":["ai","bash","developer-tools","fish","gemini","linux","llm","localai","macos","ollama","openai","openai-api","terminal","xai","zsh"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/djcopley.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["djcopley"]}},"created_at":"2023-12-11T20:23:31.000Z","updated_at":"2025-03-30T13:58:19.000Z","dependencies_parsed_at":"2024-01-27T20:31:37.629Z","dependency_job_id":"5072a0a4-a676-427a-9ec2-72ed98268eab","html_url":"https://github.com/djcopley/ShellOracle","commit_stats":{"total_commits":116,"total_committers":1,"mean_commits":116.0,"dds":0.0,"last_synced_commit":"54e7abf42307f038fae6f8321693f6aade08e5b9"},"previous_names":["djcopley/shelloracle"],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/djcopley%2FShellOracle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/djcopley%2FShellOracle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/djcopley%2FShellOracle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/djcopley%2FShellOracle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/djcopley","download_url":"https://codeload.github.com/djcopley/ShellOracle/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247878014,"owners_count":21011158,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","bash","developer-tools","fish","gemini","linux","llm","localai","macos","ollama","openai","openai-api","terminal","xai","zsh"],"created_at":"2024-09-24T13:34:02.980Z","updated_at":"2025-04-08T16:00:19.100Z","avatar_url":"https://github.com/djcopley.png","language":"Python","funding_links":["https://github.com/sponsors/djcopley"],"categories":["The latest additions 🎉"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://i.imgur.com/IsQYInJ.png\" alt=\"ShellOracle logo\"/\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eShellOracle\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/djcopley/ShellOracle/actions/workflows/tests.yml\"\u003e\u003cimg src=\"https://github.com/djcopley/ShellOracle/actions/workflows/tests.yml/badge.svg?branch=main\" alt=\"Tests\" /\u003e\u003c/a\u003e \u003ca href=\"https://badge.fury.io/py/shelloracle\"\u003e\u003cimg src=\"https://badge.fury.io/py/shelloracle.svg\" alt=\"PyPI version\" /\u003e\u003c/a\u003e \u003ca href=\"https://pypi.python.org/pypi/shelloracle/\"\u003e\u003cimg src=\"https://img.shields.io/pypi/pyversions/shelloracle.svg\" alt=\"PyPI Supported Python Versions\" /\u003e\u003c/a\u003e \u003ca href=\"https://pepy.tech/project/shelloracle\"\u003e\u003cimg src=\"https://static.pepy.tech/badge/shelloracle\" alt=\"Downloads\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nShellOracle is an innovative terminal utility designed for intelligent shell command generation, bringing a new level of\nefficiency to your command-line interactions. ShellOracle currently supports Ollama, OpenAI, Deepseek, LocalAI, and Grok!\n\n![ShellOracle](https://i.imgur.com/lqTW1lO.gif)\n\nShow your support for ShellOracle and keep an eye out for exciting new developments by clicking the ⭐ and a 👀!\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Providers](#providers)\n- [Configuration](#configuration)\n- [System Requirements](#system-requirements)\n- [Feedback](#feedback)\n\n## Features\n\nKey features of ShellOracle include:\n\n* Seamless shell command generation from written descriptions\n* Command history for easy reference\n* Unix pipe support for advanced command chaining\n* Self-hosted for full control over your environment\n* Highly configurable to adapt to your preferences\n\n## Installation\n\nInstalling ShellOracle is easy!\n\n1. [pipx](https://pipx.pypa.io/latest/) install the `shelloracle` package\n    ```shell\n    pipx install shelloracle\n    ```\n2. Configure ShellOracle and follow the prompts\n    ```shell\n    shor config init\n    ```\n3. Refer to the [providers](#providers) section for specific details regarding your chosen provider.\n\nUpgrading to the latest version of ShellOracle is just as simple!\n\n1. pipx upgrade the `shelloracle` package\n    ```shell\n   pipx upgrade shelloracle\n   ```\n\n*Installation with `pip` is supported, however, `pipx` is preferred for its automatic environment isolation.*\n\n## Usage\n\nShellOracle is designed to be used as a BASH/ZSH/fish widget activated by the CTRL+F keyboard shortcut.\n\n1. Press CTRL+F\n2. Describe your command\n3. Press Enter\n\nThe generated command will be inserted into your shell prompt after a brief processing period.\n\n### Other ways to run ShellOracle\n\nShellOracle can be run as a Python module with `python3 -m shelloracle` or using its entrypoint `shor`, however,\nrunning ShellOracle with this method will not automatically insert the result into your shell prompt.\n\n### Tips\n\n1. If you press CTRL+F with text in your ZLE buffer, all text left of your cursor will carry over to your ShellOracle\n   prompt.\n2. ⬆️ arrow and ⬇️ arrow cycle through your prompt history.\n3. ShellOracle can be chained with other commands; try: `echo \"find all the python files in my cwd\" | shor`\n\n## Providers\n\n### Ollama\n\nBefore using ShellOracle with Ollama, pull the model you chose in the configure step.\nFor example, if you chose `dolphin-mistral`, run:\n\n```shell\nollama pull dolphin-mistral\n```\n\nRefer to the [Ollama docs](https://ollama.ai) for installation, available models, and usage.\n\n### OpenAI\n\nTo use ShellOracle with OpenAI's models, create an [API key](https://platform.openai.com/account/api-keys). Edit\nyour `~/.shelloracle/config.toml` to change your provider and enter your API key.\nYou can use `shor config edit` as a shorthand to edit this file.\n\n### Deepseek\n\nTo use ShellOracle with Deepseek's models, create an [API key](https://platform.deepseek.com/api_keys). Edit\nyour `~/.shelloracle/config.toml` to change your provider and enter your API key.\nYou can use `shor config edit` as a shorthand to edit this file.\n\n### LocalAI\n\nRefer to the [LocalAI docs](https://localai.io/) for installation, available models, and usage.\n\n### XAI\n\nTo use ShellOracle with XAI's models, create an [API key](https://docs.x.ai/docs/quickstart#creating-an-api-key).\nEdit your `~/.shelloracle/config.toml` to change your provider and enter your API key.\nYou can use `shor config edit` as a shorthand to edit this file.\n\n### Google\n\nTo use ShellOracle with Google's models, create an [API key](https://aistudio.google.com/app/apikey).\nEdit your `~/.shelloracle/config.toml` to change your provider and enter your API key.\nYou can use `shor config edit` as a shorthand to edit this file.\n\n## Configuration\n\nShellOracle's configuration is your gateway to tailoring the utility to match your preferences and requirements.\nThe `~/.shelloracle/config.toml` file serves as the control center for customizing various aspects of ShellOracle's\nbehavior. You can quickly access and edit this file using the command `shor config edit`.\n\n## System Requirements\n\n### Software\n\nShellOracle supports BASH, ZSH and fish on macOS and Linux.\n\n### Hardware\n\nFor cloud providers like OpenAI, there are no hardware requirements.\n\nIf running locally, refer to your model for hardware requirements.\n\n## Feedback\n\nEncountered problems? [File an issue](https://github.com/djcopley/ShellOracle/issues/new). Feature requests are welcome,\nand contributions can be made by opening a pull request.\n\n## License\n\nThis software is licensed under the GPLv3 license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdjcopley%2Fshelloracle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdjcopley%2Fshelloracle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdjcopley%2Fshelloracle/lists"}