https://github.com/llm-workflow-engine/lwe-plugin-shell
LLM Workflow Engine (LWE) Shell plugin
https://github.com/llm-workflow-engine/lwe-plugin-shell
Last synced: 14 days ago
JSON representation
LLM Workflow Engine (LWE) Shell plugin
- Host: GitHub
- URL: https://github.com/llm-workflow-engine/lwe-plugin-shell
- Owner: llm-workflow-engine
- Created: 2023-07-13T01:02:39.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-20T22:09:32.000Z (about 1 year ago)
- Last Synced: 2024-04-20T23:20:00.189Z (about 1 year ago)
- Language: Python
- Size: 3.91 KB
- Stars: 1
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LLM Workflow Engine (LWE) Shell plugin
Shell plugin for [LLM Workflow Engine](https://github.com/llm-workflow-engine/llm-workflow-engine)
Transform natural language into a shell command, and optionally execute it.
**WARNING: POTENTIALLY DANGEROUS -- YOU ARE RESPONSIBLE FOR VALIDATING THE COMMAND RETURNED BY THE LLM, AND THE OUTCOME OF ITS EXECUTION.**
## Installation
### From packages
Install the latest version of this software directly from github with pip:
```bash
pip install git+https://github.com/llm-workflow-engine/lwe-plugin-shell
```
### From source (recommended for development)
Install the latest version of this software directly from git:
```bash
git clone https://github.com/llm-workflow-engine/lwe-plugin-shell.git
```
Install the development package:
```bash
cd lwe-plugin-shell
pip install -e .
```
## Configuration
Add the following to `config.yaml` in your profile:
```yaml
plugins:
enabled:
- shell
# Any other plugins you want enabled...
# These are the default values.
shell:
command:
confirm: true
shell:
path: null
```
## Usage
From a running LWE shell:
```
/shell Print the current working directory
```