{"id":22033813,"url":"https://github.com/PsychArch/nlsh","last_synced_at":"2025-07-23T15:31:25.083Z","repository":{"id":264461260,"uuid":"893401926","full_name":"PsychArch/nlsh","owner":"PsychArch","description":"A Zsh plugin that allows you to interact with your shell using natural language.","archived":false,"fork":false,"pushed_at":"2025-03-18T12:11:19.000Z","size":702,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-05T23:03:28.193Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","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/PsychArch.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-11-24T11:01:15.000Z","updated_at":"2025-06-02T16:48:40.000Z","dependencies_parsed_at":"2025-03-18T12:38:25.361Z","dependency_job_id":null,"html_url":"https://github.com/PsychArch/nlsh","commit_stats":null,"previous_names":["psycharch/nlsh"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/PsychArch/nlsh","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PsychArch%2Fnlsh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PsychArch%2Fnlsh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PsychArch%2Fnlsh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PsychArch%2Fnlsh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PsychArch","download_url":"https://codeload.github.com/PsychArch/nlsh/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PsychArch%2Fnlsh/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266703999,"owners_count":23971396,"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-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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":[],"created_at":"2024-11-30T09:01:36.941Z","updated_at":"2025-07-23T15:31:25.061Z","avatar_url":"https://github.com/PsychArch.png","language":"Shell","funding_links":[],"categories":["Plugins","Recently Updated"],"sub_categories":["ZSH on Windows","[Nov 30, 2024](/content/2024/11/30/README.md)"],"readme":"# Natural Language Shell (nlsh)\n\nA Zsh plugin that allows you to interact with your shell using natural language.\n\n![Natural Language Shell Demo](https://github.com/PsychArch/nlsh/blob/main/capture.gif)\n\n## Features\n\n- 🤖 Converts natural language to shell commands\n- 🔄 Supports OpenAI-compatible API endpoints\n- ⌨️ Simple keyboard shortcuts:\n  - Linux/Windows: `Alt+Enter` or `Ctrl+⬇️`\n  - macOS: `Option+Return`\n\n## Requirements\n\n- Zsh shell\n- curl command-line tool\n- jq JSON processor\n- OpenAI API key or compatible service\n\n## Installation\n\n### Option 1: Using antidote\n\nAdd to your `.zsh_plugins.txt`:\n\n```text\nPsychArch/nlsh\n```\n\nOr add directly to your `.zshrc`:\n\n```zsh\n# Initialize antidote\nsource ${ZDOTDIR:-~}/.antidote/antidote.zsh\nsource \u003c(antidote init)\n\n# Add nlsh plugin\nantidote bundle PsychArch/nlsh\n```\n\n### Option 2: Manual Installation\n\n```bash\n# 1. Clone the repository\ngit clone https://github.com/PsychArch/nlsh ~/.nlsh\n\n# 2. Add to your .zshrc\necho 'source ~/.nlsh/nlsh.plugin.zsh' \u003e\u003e ~/.zshrc\n\n# 3. Reload your shell\nsource ~/.zshrc\n```\n\n## Usage\n\n1. Type your natural language command in the terminal\n2. Press the keyboard shortcut for your platform:\n   - Linux/Windows: `Alt+Enter` or `Ctrl+⬇️`\n   - macOS: `Option+Return`\n3. Review the generated shell command\n4. Press `Enter` to execute or modify as needed\n\n## Configuration\n\nConfigure the plugin using these environment variables in your `.zshrc`:\n\n```bash\n# Required\nexport OPENAI_API_KEY=\"your-api-key\"\n\n# Optional configurations\nexport OPENAI_MODEL=\"gpt-4\"                              # Default: gpt-3.5-turbo\nexport OPENAI_URL_BASE=\"https://your-api-endpoint.com\"   # Default: https://api.openai.com\nexport OPENAI_PROXY=\"http://proxy.example.com:8080\"      # Optional: HTTP proxy\n```\n\n## How It Works\n\n1. The plugin captures your natural language input when triggered\n2. Collects relevant system information:\n   - Operating system\n   - Distribution details\n   - User privileges\n3. Sends a request to the configured OpenAI-compatible API\n4. Converts the response into an executable shell command\n\n## Security Notes\n\n- Review generated commands before execution\n- Be cautious with sensitive system commands\n- Keep your API key secure\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPsychArch%2Fnlsh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPsychArch%2Fnlsh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPsychArch%2Fnlsh/lists"}