{"id":22561999,"url":"https://github.com/venopyx/shellsense","last_synced_at":"2025-04-09T21:09:27.619Z","repository":{"id":266255885,"uuid":"897827597","full_name":"venopyX/shellsense","owner":"venopyX","description":"ShellSense is an intelligent linux terminal plugin designed to enhance your terminal experience with powerful features and AI-powered capabilities. Developed using Python, ShellSense offers a streamlined workflow for various tasks, making your terminal more efficient and user-friendly.","archived":false,"fork":false,"pushed_at":"2025-01-21T22:12:49.000Z","size":340,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-09T21:08:50.095Z","etag":null,"topics":["agent","ai","bash","copilot","intelligent","intelligent-agent","linux","pip","plugin","pypi","pypi-package","shell","shellsense","terminal","zsh"],"latest_commit_sha":null,"homepage":"https://shellsense.readthedocs.io/en/latest/","language":"Python","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/venopyX.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-12-03T10:04:40.000Z","updated_at":"2025-01-20T23:35:49.000Z","dependencies_parsed_at":"2024-12-03T11:22:53.131Z","dependency_job_id":"74a41c35-93e1-4c29-b52b-43a2ea594b1e","html_url":"https://github.com/venopyX/shellsense","commit_stats":null,"previous_names":["venopyx/shellsense"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/venopyX%2Fshellsense","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/venopyX%2Fshellsense/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/venopyX%2Fshellsense/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/venopyX%2Fshellsense/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/venopyX","download_url":"https://codeload.github.com/venopyX/shellsense/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248111975,"owners_count":21049578,"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":["agent","ai","bash","copilot","intelligent","intelligent-agent","linux","pip","plugin","pypi","pypi-package","shell","shellsense","terminal","zsh"],"created_at":"2024-12-07T22:11:12.487Z","updated_at":"2025-04-09T21:09:27.582Z","avatar_url":"https://github.com/venopyX.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ShellSense\n\n\u003cdiv align=\"center\"\u003e\n\n[![Python Version](https://img.shields.io/badge/python-3.8%2B-blue.svg)](https://www.python.org/downloads/)\n[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)\n[![PyPI version](https://badge.fury.io/py/shellsense.svg)](https://badge.fury.io/py/shellsense)\n\nA universal AI-powered terminal assistant for Linux\n\n[Features](#features) •\n[Installation](#installation) •\n[Usage](#usage) •\n[Development](#development) •\n[Contributing](#contributing)\n\n![ShellSense Demo](docs/images/shellsense-demo.gif)\n\n\u003c/div\u003e\n\n## Features\n\n- **AI Assistant**: Get expert help for any terminal task with multiple AI providers\n- **Smart Search**: Integrated web search and Wikipedia lookup\n- **Data Tools**: GitHub info, stock data, and product research\n- **Translation**: Built-in support for multiple languages\n- **Screenshots**: Capture webpage screenshots\n- **Code Help**: Generate and explain code snippets\n- **Rich Output**: Beautiful terminal formatting with loading animations\n- **Universal**: Works with any Linux terminal (bash, zsh, fish, etc.)\n- **Extensible**: Easy to add new tools and providers\n\n## Installation\n\n### Prerequisites\n\n- Python 3.8 or higher\n- pip (Python package installer)\n- Chrome/Chromium (optional, for screenshots)\n\n### Quick Install\n\n```bash\npip install shellsense\n```\n\nThat's it! ShellSense is now installed and ready to use.\n\n### First-time Setup\n\nRun the setup command to create your configuration:\n\n```bash\nshellsense --setup\n```\n\nThis creates a configuration file at `~/.config/shellsense/config.env`. Edit this file with your API keys:\n\n```env\n# OpenAI API Keys (Optional)\nOPENAI_API_KEY=your-openai-api-key\n\n# Gemini API Keys (Optional)\nGEMINI_API_KEY=your-gemini-api-key\n\n# Cloudflare Environment Variables\nCLOUDFLARE_ACCOUNT_ID=your-cloudflare-account-id\nCLOUDFLARE_AUTH_TOKEN=your-cloudflare-auth-token\nFUNCTION_CALL_MODEL=@hf/nousresearch/hermes-2-pro-mistral-7b\nFRIENDLY_RESPONSE_MODEL=@hf/mistral/mistral-7b-instruct-v0.2\n```\n\n## Usage\n\n### Basic Commands\n\n```bash\n# Show help and available commands\nshellsense --help\n\n# Use Specific AI Provider\nshellsense -p gemini -q \"What is the current weather in New York?\"\n\n# Default to Cloudflare AI\nshellsense -q \"Search Wikipedia for quantum computing\"\n```\n\n### Available Tools\n\n| Tool | Description |\n|------|-------------|\n| WebSearch | Search the web using Bing/DuckDuckGo |\n| Wikipedia | Search and retrieve Wikipedia articles |\n| Translator | Translate text between languages |\n| Screenshot | Capture webpage screenshots |\n| GitHub | Fetch GitHub user/repo information |\n| Stock | Get real-time stock market data |\n| ProductHunt | Discover trending tech products |\n| Coder | Generate code snippets and explanations |\n\n## Development\n\n### Setup Development Environment\n\n1. Clone and setup:\n   ```bash\n   git clone https://github.com/venopyX/shellsense.git\n   cd shellsense\n\n   # Create and activate virtual environment\n   python -m venv venv\n   source venv/bin/activate\n\n   # Install in development mode with dev dependencies\n   pip install -e \".[dev]\"\n   ```\n\n2. Run tests:\n   ```bash\n   pytest\n   ```\n\n3. Build documentation:\n   ```bash\n   cd docs\n   make html\n   ```\n\n4. Build and publish:\n   ```bash\n   python -m build\n   twine upload dist/*\n   ```\n\n### Project Structure\n\n```\nshellsense/\n├── shellsense/        # Main package\n│   ├── ai/           # AI providers and models\n│   │   └── providers/# AI provider implementations\n│   ├── tools/        # Tool implementations\n│   │   ├── coder/    # Code generation tools\n│   │   ├── data/     # Data processing tools\n│   │   ├── language/ # Language tools\n│   │   ├── media/    # Media tools\n│   │   ├── shell/    # Shell tools\n│   │   └── web/      # Web tools\n│   ├── config/       # Configuration management\n│   ├── utils/        # Utility functions\n│   └── __main__.py   # CLI entry point\n├── tests/            # Test suite\n├── docs/             # Documentation\n│   ├── api/         # API reference\n│   ├── guides/      # User guides\n│   └── examples/    # Usage examples\n└── pyproject.toml    # Project configuration\n```\n\n### Code Style\n\nWe use industry-standard Python tools:\n- Black for code formatting\n- isort for import sorting\n- flake8 for linting\n- mypy for type checking\n\nRun all checks:\n```bash\nblack .\nisort .\nflake8 .\nmypy .\n```\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.\n\n1. Fork the repository\n2. Create your feature branch\n3. Make your changes\n4. Run the tests\n5. Submit a pull request\n\n## Documentation\n\nFor comprehensive documentation, visit our [Documentation](https://shellsense.readthedocs.io/en/latest/). Key sections include:\n\n- [API Reference](https://shellsense.readthedocs.io/en/latest/api/index.html): Detailed API documentation\n- [User Guides](https://shellsense.readthedocs.io/en/latest/guides/index.html): Step-by-step guides\n- [Examples](https://shellsense.readthedocs.io/en/latest/examples/index.html): Usage examples\n- [Contributing Guide](CONTRIBUTING.md): How to contribute\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Support\n\n- [Documentation](docs/README.md)\n- [Issue Tracker](https://github.com/venopyX/shellsense/issues)\n- [Discussions](https://github.com/venopyX/shellsense/discussions)\n\n---\n\n\u003cdiv align=\"center\"\u003e\nMade with ❤️ by the Gemechis Chala\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvenopyx%2Fshellsense","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvenopyx%2Fshellsense","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvenopyx%2Fshellsense/lists"}