{"id":14529819,"url":"https://github.com/BalanceBalls/nekot","last_synced_at":"2025-09-02T00:32:58.748Z","repository":{"id":225930626,"uuid":"720932048","full_name":"BalanceBalls/nekot","owner":"BalanceBalls","description":"A portable terminal AI interface","archived":false,"fork":false,"pushed_at":"2025-08-16T12:50:07.000Z","size":53785,"stargazers_count":52,"open_issues_count":4,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-01T02:04:06.618Z","etag":null,"topics":["chatgpt-api","gemini-api","go","ollama","terminal","ui"],"latest_commit_sha":null,"homepage":"","language":"Go","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/BalanceBalls.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","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":"2023-11-20T02:00:33.000Z","updated_at":"2025-08-30T15:01:39.000Z","dependencies_parsed_at":"2024-04-20T20:22:53.047Z","dependency_job_id":"af6e73d7-65f2-4bce-8012-fb3f5c32273f","html_url":"https://github.com/BalanceBalls/nekot","commit_stats":null,"previous_names":["tearingitup786/chatgpt-tui","tearingitup786/golang-tui","tearingitup786/nekot","balanceballs/nekot"],"tags_count":64,"template":false,"template_full_name":null,"purl":"pkg:github/BalanceBalls/nekot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BalanceBalls%2Fnekot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BalanceBalls%2Fnekot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BalanceBalls%2Fnekot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BalanceBalls%2Fnekot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BalanceBalls","download_url":"https://codeload.github.com/BalanceBalls/nekot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BalanceBalls%2Fnekot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273213815,"owners_count":25065058,"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","status":"online","status_checked_at":"2025-09-01T02:00:09.058Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["chatgpt-api","gemini-api","go","ollama","terminal","ui"],"created_at":"2024-09-05T00:01:02.680Z","updated_at":"2025-09-02T00:32:58.737Z","avatar_url":"https://github.com/BalanceBalls.png","language":"Go","funding_links":[],"categories":["Applications","Go"],"sub_categories":["AI"],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./docs/images/nekot-logo.png\" width=\"250\" title=\"logo\"\u003e\n  \u003ch1 align=\"center\"\u003e\n    NEKOT\n  \u003c/h1\u003e\n\n**A powerful and intuitive terminal utility for interacting with both local and cloud LLMs.**\n\nA tool for those who appreciate keyboard driven apps and terminal workflows\n\n\u003c/p\u003e\n\n## Features\n * 📦 **Single binary** - lightweight, zero dependencies, use anywhere without any requirements\n * 🤖 **Support for OpenAI compatible APIs** (ChatGPT, Mistral, Ollama, LMStudio, and more)\n * 🌟 **Support for Gemini API**\n * 💬 **Chat sessions** management and quick chats\n * ⚙️ **Settings presets** (configure different personas with unique settings)\n * ✂️ **Convenient text selection** tool (vim-like line selection)\n * 🌐 **Crossplatform** - support for MacOS, Windows and Linux\n * 🎨 **Multiple themes**\n\n## Demo\n\n![tui demo](./docs/images/nekot-demo.gif)\n\n## App installation\n\n**Ensure API keys are set before proceeding to installtion**\n\n### Homebrew (MacOS, Linux)\n\n```bash\nbrew tap BalanceBalls/BalanceBalls\nbrew install nekot --cask\n```\n\n### Chocolatey (Windows)\n\n```bash\nchoco install nekot\n```\n\n### Shell script (Linux, MacOS)\n\nRequires `curl` and `tar`.\n\n**For updating the app, just run the script again**\n\n**Basic install:**\n* Requires `sudo`, and installs to `/usr/local/bin/`\n```bash\ncurl -fsSL https://raw.githubusercontent.com/BalanceBalls/nekot/main/install.sh | sudo sh\n```\n\n**Install to path:**\n* Use `-p` flag to specify install path.\n* Make sure the specified directory is in the `$PATH`.\n* May require `sudo` depending on the path specified.\n```bash\nbash -c \"$(curl -fsSL https://raw.githubusercontent.com/BalanceBalls/nekot/main/install.sh)\" -- -p ~/.local/bin\n```\n\n### Download binary/executable (Windows, MacOS, Linux)\n\n1. [Go to latest release](https://github.com/BalanceBalls/nekot/releases/latest)\n2. Download and extract the archive\n3. Place the binary/executable in some directory\n4. Add that directory to `$PATH`\n\n## Setting API keys\n\nTo use the app, you will need to set `OPENAI_API_KEY` or/and `GEMINI_API_KEY` env variables depending on your needs\n\n\u003cdetails\u003e\n\n\u003csummary\u003eAPI keys guide\u003c/summary\u003e\n\n### OpenAI APIs\n\n\u003ci\u003eFor local models the key still needs to be set (`OPENAI_API_KEY=1` will do).\u003c/i\u003e\n\nSet up your openai api key:\n* ChatGPT: [how to get an api key](https://platform.openai.com/api-keys)\n* Mistral: [how to get an api key](https://docs.mistral.ai/getting-started/quickstart/#account-setup)\n\n```bash\nexport OPENAI_API_KEY=\"some-key\" # you would want to export this in your .zshrc or .bashrc\n```\n\n### Gemini API\n\nSet up your api key - [how to get an api key](https://aistudio.google.com/apikey)\n\n```bash\nexport  GEMINI_API_KEY=\"some-key\" # you would want to export this in your .zshrc or .bashrc\n```\n\u003c/details\u003e\n\n## Config\n\nWe provide a `config.json` file within your directory for easy access to essential settings.\n- On **MacOS \u0026 Linux**, the path is `~/.nekot/config.json`.\n- On **Windows**, the path is `C:\\Users\\%UserName%\\.nekot\\config.json` or `%HOMEPATH%\\.nekot\\config.json`\n\n### Example\n```json\n{\n  \"providerBaseUrl\": \"https://api.openai.com\", // Or http://localhost:1143, or any other OpenAi compatible API\n  \"systemMessage\": \"\",\n  \"defaultModel\": \"\",\n  \"colorScheme\": \"groove\", // pink, blue, groove\n  \"provider\": \"openai\" // openai, gemini\n}\n```\n\n - `providerBaseUrl`: The url can be anything that follows OpenAI API standard ( [ollama](http://localhost:11434), [lmstudio](http://127.0.0.1:1234), etc)\n - `chatGPTApiUrl` [obsolete]: same as `providerBaseUrl`\n - `systemMessage` field is available for customizing system prompt messages. **Better to set it from the app**\n - `defaultModel` field sets the default model.  **Better to set it from the app**\n\n### Providers\n\nYou can change API provider using the `provider` field.\n\nAvailable providers:\n * `openai` **default**\n * `gemini`\n\nTo use **GeminiAPI**, just set `\"provider\": \"gemini\"` (make sure to set GEMINI_API_KEY env variable).\nWhen using the `gemini` provider, `providerBaseUrl` param is not used.\n\n### Themes\nYou can change colorscheme using the `colorScheme` field.\n\nAvailable themes:\n * `groove` **default**\n * `pink`\n * `blue`\n\n\n## Data migration\n\nIf you need your settings and chats on other machine - simply copy `chat.db` and `config.json` from the `.nekot/` directory\nand paste to the same directory on other machine.\n\n## Flags\n\n### Cache invalidation\n\nModels list is cached for 14 days upon loading. If you need to invalidate cache use `--purge-cache` flag:\n```bash\nnekot --purge-cache\n```\n\n### Provider\n\nTo switch between openai and gemini APIs you can use `-p` flag:\n```bash\nnekot -p openai\nnekot -p gemini\n```\n\n### Provider url\n\nTo specify provier url use `-u` flag(works with the openai provider only):\n```bash\nnekot -u http://localhost:11434\n```\n\n### Theme\n\nTo specify color scheme use `-t` flag:\n```bash\nnekot -t blue\n```\n\n## Global Keybindings\n\n- `Tab`: Change focus between panes. The currently focused pane will be highlighted\n- `1-4` pane jumps: `1` **prompt** pane, `2`, **chat** pane, `3` **settings** pane, `4` **sessions** pane\n- `Ctrl+b` or `Ctrl+s`: Interrupt inference\n- `Ctrl+o`: Toggles zen mode\n- `Ctrl+c`: Exit the program\n- `Ctrl+n`: Create new session\n- `Ctrl+q`: Start quick chat\n- `Ctrl+x`: Save quick chat to session\n\n## Prompt Pane\n\n- `i`: Enters insert mode (you can now safely paste messages into the tui)\n- `Ctrl+e`: Open/Close prompt editor\n- `Ctrl+r`: Clear prompt\n- `Ctrl+v`: Paste text from buffer\n- `Ctrl+s`: Paste text from buffer as a code block (only in editor mode)\n    * if current line contains text, that text will be used as a language for the code block\n    * Example: if a line contains `go` the result of `Ctrl+s` will be:\n\n    \\```go \u003cbr\u003e\n    {bufferContent} \u003cbr\u003e\n    \\```\n- `esc`: Exit insert mode for the prompt\n    * When in 'Prompt editor' mode, pressing `esc` second time will close editor\n\n## Chat Messages Pane\n\n- `y`: Copies the last message into your clipboard.\n- `Shift+y`: Copies all messages from current session into your clipboard.\n- `v`, `Shift+v` or `space`: Enters navigation mode when chat pane is focused (allows to move accross the chat content lines)\n\n### Selection mode\n\nSelection mode allows to navigate the chat pane and select lines to copy. Supports basic vim-motions.\n\n\u003cb\u003eNavigation\u003c/b\u003e\n - `j`, `k` - go down and up a line\n - `d`, `u`, `Ctrl+d`, `Ctrl+u` - go up or down half page\n - `g` - go to top\n - `Shift+g` - go to bottom\n\n\u003cb\u003eSelection\u003c/b\u003e\n - `d`, `u`, `Ctrl+d`, `Ctrl+u` - go up or down half page\n - `j`, `k` - go down and up a line\n   - Multiline jumps like `3j` (3 lines down), `99k` (99 lines up) are also supported\n- `v`, `Shift+v` or `space` to enter or quit line selection mode\n- `y` to copy selected text\n- `Esc` to quit selection or navigation modes\n\n## Settings Pane\n\n- `[` and `]`: switch between presets and settings tabs\n\n### Settings tab\n- `m`: Opens a model picker to change the model. (use `/` to set filter)\n- `f`: Change the frequency value\n- `t`: Change the maximum number of tokens per message\n- `e`: Change the temperature value\n- `p`: Change the top_p value (nucleus sampling)\n- `s`: Opens a text editor to edit system prompt\n- `Ctrl+r`: resets current settings preset to default values\n- `Ctrl+p`: creates new preset with a specified name from the current preset\n\n### Presets tab\n- `d`: remove preset (default and current selected presets cannot be removed)\n- `enter`: select preset as the current one\n- `/`: filter presets\n\n## Sessions Pane\n\n- `Ctrl+n`: Creates a new session.\n- `d`: Deletes the currently selected session from the list.\n- `e`: Edit session name\n- `Enter`: Switches to the session that is currently selected.\n- `/`: filter sessions\n\n## Info pane\n\nInformation pane displays processing state of inference (`IDLE`, `PROCESSING`) as well as token stats for the current session:\n - `IN`: shows the total amount of input tokens LLM consumed per session\n - `OUT`: shows the total amount of output tokens LLM produced per session\n\nPlease refer to this guide as you navigate the TUI. Happy exploring!\n\n### Dev notes\n\nThe SQL db is stored in you `your/home/directory/.nekot`, as well as the debug log. To enable `debug` mode, `export DEBUG=1` before running the program.\n\nTo get access to the release candidates, install command:\n\n```bash\nbrew install rc-nekot\nrc-nekot\n```\n\n## Technologies\n\n- Go\n- [bubbletea](https://github.com/charmbracelet/bubbletea): A Go framework for\n  terminal user interfaces. It's a great framework that makes it easy to create\n  TUIs in Go.\n- [openai](https://platform.openai.com/docs/api-reference): OpenAI's REST Api\n- [sqlite](https://gitlab.com/cznic/sqlite): CGO-free sqlite lib\n- [lipgloss](https://github.com/charmbracelet/lipgloss): Style definitions for\n  nice terminal layouts!\n- [bubbles](https://github.com/charmbracelet/bubbles): Some general use\n  components for Bubble Tea apps!\n\n## Contributors\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/BalanceBalls\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/29193297?v=4?s=100\" width=\"100px;\" alt=\"BalanceBalls\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eBalanceBalls\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#doc-BalanceBalls\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#code-BalanceBalls\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://twitter.com/tearingitup786\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/16584942?v=4?s=100\" width=\"100px;\" alt=\"Taranveer (Taran) Bains\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eTaranveer (Taran) Bains\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#doc-tearingItUp786\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#maintenance-tearingItUp786\" title=\"Maintenance\"\u003e🚧\u003c/a\u003e \u003ca href=\"#review-tearingItUp786\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e \u003ca href=\"#code-tearingItUp786\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://www.tjmiller.me\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/5108034?v=4?s=100\" width=\"100px;\" alt=\"TJ Miller\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eTJ Miller\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#doc-sixlive\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#code-sixlive\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBalanceBalls%2Fnekot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBalanceBalls%2Fnekot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBalanceBalls%2Fnekot/lists"}