{"id":17687724,"url":"https://github.com/andygeek/jarvis-sh","last_synced_at":"2026-03-07T08:03:14.304Z","repository":{"id":257822931,"uuid":"864761481","full_name":"andygeek/jarvis-sh","owner":"andygeek","description":"An AI-powered command-line assistant for your terminal.","archived":false,"fork":false,"pushed_at":"2024-10-29T04:25:26.000Z","size":1195,"stargazers_count":8,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2026-02-13T12:42:49.736Z","etag":null,"topics":["ai","bash"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andygeek.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-09-29T05:02:50.000Z","updated_at":"2025-12-13T03:30:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"837b629f-7104-4a1e-bda1-3c1c9658ac61","html_url":"https://github.com/andygeek/jarvis-sh","commit_stats":{"total_commits":58,"total_committers":2,"mean_commits":29.0,"dds":"0.017241379310344862","last_synced_commit":"8ecde5433516bc148ac650c212ab8daa0b94c52c"},"previous_names":["andygeek/jarvis-sh"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/andygeek/jarvis-sh","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andygeek%2Fjarvis-sh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andygeek%2Fjarvis-sh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andygeek%2Fjarvis-sh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andygeek%2Fjarvis-sh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andygeek","download_url":"https://codeload.github.com/andygeek/jarvis-sh/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andygeek%2Fjarvis-sh/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30209797,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T05:23:27.321Z","status":"ssl_error","status_checked_at":"2026-03-07T05:00:17.256Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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"],"created_at":"2024-10-24T11:07:58.929Z","updated_at":"2026-03-07T08:03:14.273Z","avatar_url":"https://github.com/andygeek.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jarvis-sh\n\nAn AI-powered command-line assistant for your terminal, compatible with both local AI models via Ollama and OpenAI. It not only supports executing commands but also intelligently suggests and finds commands from its own knowledge base or a predefined list, taking your productivity as a developer or DevOps engineer to the next level.\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://imgur.com/kpM3SQ2.png\" alt=\"Descripción de la imagen\" width=\"200px\" /\u003e\n\u003c/div\u003e\n\n## Prerequisites\n\nBefore installing Jarvis-sh, ensure you have the following:\n\n- **Node.js**: Version 19 or higher is recommended. This is required for running Jarvis-sh.\n- **Ollama** (Optional): If you want to use local open-source AI models, you'll need to install Ollama, a runtime for large language models. You can install it from [here](https://ollama.ai/).\n- **AI Model** (Optional): A local AI model compatible with Ollama. We recommend using `llama3.2`. Make sure the model is downloaded and available for use.\n\n### Installing Ollama\n\nFollow the instructions on the [Ollama website](https://ollama.ai/) to install Ollama on your system.\n\n### Installing the AI Model\n\nAfter installing Ollama, install the `llama3.2` model by running:\n\n```bash\nollama pull llama3.1:8b\n```\n\n## Installation jarvis-sh\n\nInstall Jarvis-sh globally using npm:\n\n```bash\nnpm install -g jarvis-sh\n```\n\nThis will make the `jarvis` command available globally on your system.\n\n## Configuration\n\n### AI Service and Model\n\nYou can set up both the AI service and the model using the interactive setup command:\n\n```bash\njarvis --setup\n```\n\nThis command will guide you through selecting the AI service and model. Currently, we support the following services:\n\n- `OpenAI`\n- `Anthropic`\n- `Ollama`\n\nFor **OpenAI** and **Anthropic**, you will need to provide an API key, which you can obtain from the respective provider. For **Ollama**, the models available are those installed locally, and you can list them using `ollama list`.\n\n### API Key (For OpenAI and Anthropic)\n\nIf you choose **OpenAI** or **Anthropic** as your AI service, you will be prompted to enter your API key during the setup process. Be sure to have it ready beforehand.\n\nThis is all handled automatically when using the `--setup` command, so no need for additional configuration commands.\n\n## Usage\n\nOnce installed, you can use Jarvis-sh by typing `jarvis` followed by your question or command in the terminal.\n\n### Ask a Question\n\nTo ask a question:\n\n```bash\njarvis Hello\n```\n\nJarvis-sh will provide an answer directly in the terminal.\n\nIf you want to use the `?` symbol at the end of your questions to Jarvis, you need to apply the [following configuration](doc/ZshUsers.md) in your terminal.\n\n### Execute Commands\n\nIf your input relates to terminal commands, Jarvis-sh will suggest commands that you can execute.\n\n```bash\njarvis show me the commands to generate an apk?\n```\n\nYou will be presented with a list of commands to choose from. Select the desired command to execute it.\n\n### Edit Custom Commands\n\nYou can add or edit custom commands that Jarvis-sh will consider when generating suggestions.\n\n```bash\njarvis --commands\n```\n\nThis will open a text editor (default is `nano` unless specified in the `EDITOR` environment variable) where you can add your custom commands.\n\n## Tools\n\nCurrently, we offer a tool called `/commit`, which generates the title and description of your staged changes in your Git repository using the **Conventional Commits** format. To use it, simply run the following command:\n\n```bash\njarvis /commit\n```\n\nExample response:\n```bash\nTitle: feat: update README with new configuration options and services\nDescription: Enhanced the README.md by adding new sections for AI service configuration, model configuration, and API key setup for OpenAI. Updated prerequisites to clarify the installation requirements for Node.js and Ollama. Improved descriptions for features and included instructions for service options, enhancing overall clarity and usability.\nDo you want to commit with this message? (y/n)\n```\n\nMore tools will be added soon.\n\n## Troubleshooting\n\n### Ollama is Not Initialized\n\nIf you encounter the error:\n\n```\nOllama is not initialized.\n```\n\nEnsure that Ollama is running. Start Ollama by running:\n\n```bash\nollama serve\n```\n\n### Model Not Found\n\nIf the AI model is not installed, you will see an error message indicating that the model does not exist.\n\nInstall the required model using:\n\n```bash\nollama pull \u003cmodel-name\u003e\n```\n\nFor example:\n\n```bash\nollama pull llama3.2\n```\n\n## Contributing\n\nContributions are welcome! Please open an issue or submit a pull request on GitHub.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandygeek%2Fjarvis-sh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandygeek%2Fjarvis-sh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandygeek%2Fjarvis-sh/lists"}