{"id":36496205,"url":"https://github.com/lian-rr/clio","last_synced_at":"2026-01-12T02:04:33.708Z","repository":{"id":258688216,"uuid":"861428089","full_name":"lian-rr/clio","owner":"lian-rr","description":"Your terminal's ultimate companion.","archived":false,"fork":false,"pushed_at":"2025-04-28T15:17:35.000Z","size":1619,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-28T16:26:43.062Z","etag":null,"topics":["bash","charmbracelet","fish","go","shell"],"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/lian-rr.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}},"created_at":"2024-09-22T21:24:06.000Z","updated_at":"2025-04-28T15:14:36.000Z","dependencies_parsed_at":"2024-12-07T02:31:49.302Z","dependency_job_id":null,"html_url":"https://github.com/lian-rr/clio","commit_stats":null,"previous_names":["lian-rr/keep","lian-rr/clio"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/lian-rr/clio","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lian-rr%2Fclio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lian-rr%2Fclio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lian-rr%2Fclio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lian-rr%2Fclio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lian-rr","download_url":"https://codeload.github.com/lian-rr/clio/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lian-rr%2Fclio/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28331515,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T00:36:25.062Z","status":"online","status_checked_at":"2026-01-12T02:00:08.677Z","response_time":98,"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":["bash","charmbracelet","fish","go","shell"],"created_at":"2026-01-12T02:01:40.568Z","updated_at":"2026-01-12T02:04:33.700Z","avatar_url":"https://github.com/lian-rr.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CLIo\n**CLIo** is your terminal's ultimate companion, \nuser-friendly TUI (Text User Interface) application designed to help you explore, use, \nand understand the terminal commands effortlessly.\n\nWhether you're a beginner trying to learn the command-line interface (CLI) or a seasoned pro looking for a handy way of storing your library, \nCLIo offers an intuitive and powerful way to master your shell.\n\n![CLIo demo](./assets/demo.gif)\n\n## Installation\n### Install latest binary\nThe recommended approach is to use the installation script, which automatically handles the installation of **CLIo** including the requirements for your environment.\n```sh\ncurl --proto '=https' --tlsv1.2 -LsSf https://github.com/lian-rr/clio/releases/latest/download/clio-installer.sh | sh\n```\n### From source\n\n#### Prerequisites\n- go `v.1.21+`\n\n#### Install with Go\n```sh\ngo install --tags \"fts5\" github.com/lian-rr/clio@latest\n```\n\n### Build from source\n```sh\ngit clone https://github.com/lian-rr/clio\ncd clio\ngo build --tags \"fts5\" .\n```\n\n\u003e Remeber to add the binary path to your `PATH` environment variable\n\n## Features\n\n- 📚 **Command Library**: Browse a comprehensive list of terminal commands with detailed descriptions.\n- 📖 **Command Explanations**: Get beginner-friendly explanations of commands, powered by OpenAI.\n- 🔍 **Search and Filter**: Quickly find commands by name, keyword, or functionality.\n- 📋 **History**: See previous uses of the command with the arguments used.\n\n### Roadmap\n- Export/Import command library.\n- Configure custom Explanation engines (e.g Ollama)\n- Custom Themes\n- Custom Keymaps\n\n## Configuration\nIn case you want to customize some of **CLIo**'s options \nyou can provide the necessary configuration in the config file. \n\n**CLIo** checks for the configuration in the `$HOME/.config/clio/clio.toml` file.\nThis path can be replaced by setting the `CLIO_CONFIG_PATH` environment variable.\n\n### Example config\n```toml\n# write debug logs.\ndebug = false\n# base path for storing the application data, e.g. SQLite db.\npathOverride = \"\"\n\n# explanation feature configuration.\n[professor]\n# used for enabling the explanation feature.\nenabled = false\n# type of processor. Supported values [openai]. required if professor is enable.\ntype = \"openai\"\n\n# openAI config for the openai professor.\n[professor.openai]\n# OpenAI key. required\nkey = \"key\"\n# Used if you want to customize the explanation prompt. \n# (This will completly replace the default prompt)\ncustomPrompt = \"\"\n# Url for the API.\nurl = \"\"\n# OpenAI model.\nmodel = \"\"\n```\n\n## Discloure\nUntil the version `v.1.0.0`, bugs are expected and backwards compatibility not promised.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flian-rr%2Fclio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flian-rr%2Fclio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flian-rr%2Fclio/lists"}