{"id":13603170,"url":"https://github.com/subbu963/bott","last_synced_at":"2025-04-11T13:33:13.188Z","repository":{"id":213933639,"uuid":"728212022","full_name":"subbu963/bott","owner":"subbu963","description":"bott: Your Terminal Copilot","archived":false,"fork":false,"pushed_at":"2024-01-28T04:46:38.000Z","size":985,"stargazers_count":84,"open_issues_count":1,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-29T07:34:29.007Z","etag":null,"topics":["chatbot","chatgpt","llama","llm","ollama","openai","terminal-based"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/subbu963.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2023-12-06T13:18:38.000Z","updated_at":"2024-10-08T15:01:01.000Z","dependencies_parsed_at":"2024-01-14T04:39:23.225Z","dependency_job_id":"bd24e02d-df39-4661-9685-3722fdb79ba7","html_url":"https://github.com/subbu963/bott","commit_stats":{"total_commits":48,"total_committers":2,"mean_commits":24.0,"dds":"0.22916666666666663","last_synced_commit":"29beb46df009a1580bd2b4f9cd10d6bf15af1134"},"previous_names":["subbu963/bott"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subbu963%2Fbott","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subbu963%2Fbott/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subbu963%2Fbott/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subbu963%2Fbott/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/subbu963","download_url":"https://codeload.github.com/subbu963/bott/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223470517,"owners_count":17150559,"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":["chatbot","chatgpt","llama","llm","ollama","openai","terminal-based"],"created_at":"2024-08-01T18:01:55.217Z","updated_at":"2025-04-11T13:33:13.181Z","avatar_url":"https://github.com/subbu963.png","language":"Rust","funding_links":[],"categories":["chatgpt","Rust"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./assets/bott.png\"/\u003e\n\u003c/p\u003e\n\n# Welcome to `bott`: Your Terminal Copilot\n`bott` (short for bot-in-terminal) is not just a command line tool; it's your copilot in the vast world of the terminal. Designed to make you feel like a terminal pro, bott assists you with day-to-day activities, provides helpful tips, and even adds a touch of humor to your command line experience.\n\u003cp align=\"left\"\u003e\n  \u003cimg src=\"./assets/query.gif\"/\u003e\n\u003c/p\u003e\n\u003cp align=\"right\"\u003e\n  \u003cimg src=\"./assets/debug.gif\"/\u003e\n\u003c/p\u003e\n\n## Installation\n### Rust\nInstall rust if you don't have it already and ensure a version greater than 1.74.0\n```bash\n$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh\n$ source $HOME/.cargo/env\n$ rustc --version\n```\n### Bott\nInstall bott with a single command:\n```bash\n$ curl -o- https://raw.githubusercontent.com/subbu963/bott/v0.1.0/install.sh | bash \n```\n\n## Usage\nWhether you prefer the intelligence of OpenAI or the wisdom of Ollama, bott has you covered. Choose your Large Language Model (LLM) and unleash the power of your terminal.\n### Choosing your LLM (Large Language Model)\n#### With Openai\n1. Navigate to [OpenAI's API Keys section](https://platform.openai.com/api-keys) and create a new API key or use an existing one.\n2. Configure bott to use OpenAI:\n```bash\n$ bott! config set -k llm openai\n$ bott! config set -k openai:api_key -v YOUR_API_KEY\n```\nSecurely stored in a keychain, your API key is safe with bott.\n\n3. Default model is `gpt-4`. If you want to change the OpenAI model (refer to [OpenAI's documentation](https://platform.openai.com/docs/models/gpt-4-and-gpt-4-turbo for available models), do:\n```bash\n$ bott! config set -k openai:model -v YOUR_PREFERRED_MODEL\n```\n#### With Ollama\n1. Download Ollama from [ollama.ai](https://ollama.ai).\n2. Default model is `codellama:7b-instruct`. If you want to change the model (refer to the [library](https://ollama.ai/library) for available models), do:\n```bash\n$ ollama pull codellama:7b-instruct\n$ bott! config set -k ollama:model -v codellama:7b-instruct\n```\n3. Configure bott to use Ollama:\n```bash\n$ bott! config set -k llm -v ollama\n```\nSecure and ready, bott now utilizes the Ollama model to enhance your terminal experience.\n### Commands\n#### Queries\nBott excels in aiding you with everyday terminal activities. For instance, when working in a Git repository and wanting to add only the changed JS files to a commit:\n```bash\n$ bott! query \"figure out all the js files that i have changed in the current directory and add them to the commit.\"\n```\nBott keeps track of sessions, allowing you to ask follow-up questions:\n```bash\n$ bott! query \"do the same for html files as well\"\n```\n#### Debug\nWhen troubleshooting commands, bott shines as your debugging assistant. If a command found online, like fetching the OS version, fails:\n```bash\n$ bott! run cat /etc/os-release\n$ bott! debug\n```\nBott steps in to investigate and find out why the command is failing on your system.\n\nEnjoy the journey with bott, your trusty companion in the terminal!\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsubbu963%2Fbott","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsubbu963%2Fbott","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsubbu963%2Fbott/lists"}