https://github.com/secdev-lab/wish
https://github.com/secdev-lab/wish
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/secdev-lab/wish
- Owner: SecDev-Lab
- License: agpl-3.0
- Created: 2025-02-27T04:01:28.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-17T10:52:50.000Z (about 1 year ago)
- Last Synced: 2025-03-17T11:04:24.200Z (about 1 year ago)
- Language: Python
- Size: 2.99 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wish - LLM-assisted shell for penetration testing
[](https://pypi.org/project/wish-sh)
## Overview
wish-sh is an LLM-assisted shell that helps users execute commands by translating natural language "wishes" into executable shell commands. It provides a user-friendly TUI (Text-based User Interface) for reviewing suggested commands, executing them, and monitoring their execution status. For a comprehensive technical overview, see our [whitepaper](docs/whitepaper.md).
[](https://youtube.com/watch?v=gasylKGeT2E)
## Features
- **Natural Language Command Generation**: Input your wishes in natural language and get executable commands
- **Command Suggestion and Confirmation**: Review suggested commands before execution
- **Real-time Status Monitoring**: Track command execution status in real-time
- **Command History**: Access and reuse previous commands
- **TUI Interface**: User-friendly terminal interface built with Textual
- **Knowledge Base Management**: Load and manage knowledge bases from GitHub repositories for enhanced command suggestions
- **Sliver C2 Integration**: Execute commands on remote systems through Sliver C2 framework
## Installation & Configuration
For detailed installation and configuration instructions, see the [Setup Guide](docs/setup.md).
Quick start:
```bash
pip install wish-sh
export OPENAI_API_KEY=your-api-key-here
wish # or wish-sh on macOS
```
## Documentation
- [Setup Guide](docs/setup.md) - Installation and configuration
- [Basic Usage Guide](docs/usage-01-basic.md) - Getting started with wish-sh
- [Knowledge Loader Guide](docs/usage-02-knowledge-loader.md) - Enhancing wish-sh with domain knowledge
- [Command and Control (C2) Guide](docs/usage-03-C2.md) - Advanced operations for target systems
- [LangSmith Integration Guide](docs/usage-04-langsmith.md) - Monitoring, debugging, and optimizing with LangSmith
- [Design Documentation](docs/design.md) - Technical architecture and design
- [Whitepaper](docs/whitepaper.md) - Technical whitepaper on wish architecture and capabilities
## Development
Refer to the README.md in each package `wish-*/`.
For contribution guidelines, including how to update the CHANGELOG and release process, see [Contributing Guidelines](CONTRIBUTING.md).
## License
[GNU Affero General Public License v3.0](LICENSE)