https://github.com/shresht7/nlpowershell
Use natural language to interact with PowerShell
https://github.com/shresht7/nlpowershell
command-line natural-language powershell
Last synced: 2 months ago
JSON representation
Use natural language to interact with PowerShell
- Host: GitHub
- URL: https://github.com/shresht7/nlpowershell
- Owner: Shresht7
- License: mit
- Created: 2022-12-12T18:51:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-05T09:29:38.000Z (3 months ago)
- Last Synced: 2025-03-05T10:30:01.647Z (3 months ago)
- Topics: command-line, natural-language, powershell
- Language: PowerShell
- Homepage:
- Size: 125 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NLPowerShell
Use natural language to interact with PowerShell
Inspired by: [Codex-CLI](https://github.com/microsoft/Codex-CLI)
> [!CAUTION]
>
> _Nothing is perfect!_ Read and verify AI-generated commands before running them. Treat them as if you found them on the internet—because they **are** commands from the internet. **Do not run** any command that you **do not understand**.
---
## ⭐ Features
1. Convert Natural Language to PowerShell Commands
2. Get an Explanation
### 1. Convert Natural Language to PowerShell Commands
```powershell
PS> # Get a list of the 5 most CPU-intensive processes
```
Press Ctrl + Shift + Insert
```powershell
PS> Get-Process | Sort-Object CPU -Descending | Select-Object -First 5 # Get a list of the 5 most CPU-intensive processes
```
>[!TIP]
>
> **NLPowerShell can leverage `Get-Help` or `--help` automatically to improve prediction accuracy**
>
> ```powershell
> PS> git # list all tags
> ```
>
> Press Ctrl + Ctrl + Insert
>
> ```powershell
> PS> git tag --list # list all tags
> ```
### 2. Get an Explanation
```powershell
PS> Get-Command | Get-Random | Get-Help -Full
```
Press Ctrl + Shift + Insert
```powershell
PS> Get-Command | Get-Random | Get-Help -Full # Retrieve a random command and display its full help information.
```
---
## 📦 Installation
### 1. Clone this repository
```powershell
git clone https://github.com/Shresht7/NLPowerShell.git
```
or
```powershell
gh repo clone Shresht7/NLPowerShell
```
### 2. Import the module
```powershell
Import-Module -Name
```
> [!TIP]
>
> If the module is placed in `$PSModulePath` (either manually, by installation, or via symlink), it can be imported with `Import-Module -Name NLPowerShell`.
>[!NOTE]
>
> Adding this import to your `$PROFILE` will load the module automatically when PowerShell starts. You can also `Initialize-NLPowerShell` straight-away with your desired configuration.
>
> ```powershell
> Import-Module -Name NLPowerShell
> Initialize-NLPowerShell -Ollama -Model "qwen2.5-coder" -Temperature 0.2
> ```
### 3. Initialize the configuration
#### Using Ollama
```powershell
Initialize-NLPowerShell -Ollama -Model "llama3.2"
```
#### Using OpenAI
```powershell
Initialize-NLPowerShell -OpenAI -Model "gpt-4" -API_KEY (Read-Host -AsSecureString -Prompt "OpenAI API Key")
```
or you can read configuration from a file
```powershell
Initialize-NLPowerShell -Path "Config.json"
```
#### Changing the Keybinding
```powershell
Initialize-NLPowerShell -KeyBind "Ctrl+Insert"
```
---
## ⚙️ Configuration
### To view the configuration
```powershell
Get-NLPowerShellConfig
```
### To update the configuration parameters
```powershell
Set-NLPowerShellConfig -Provider Ollama -Model "llama3.2" -MaxTokens 64
```
### To export the configuration to file
```powershell
Export-NLPowerShellConfig -Path "Config.json"
```
or
```powershell
Export-NLPowerShellConfig -Path "config.xml"
```
### To import the configuration
```powershell
Import-NLPowerShellConfig -Path "config.xml"
```
---
## 📖 Examples
```powershell
PS> # Get a list of markdown files
```
Press Ctrl + Shift + Insert
```powershell
PS> Get-ChildItem -Path . -Filter "*.md" # Get a list of markdown files
```
```powershell
PS> Get-Date
```
Press Ctrl + Shift + Insert
```powershell
PS> Get-Date # Get the current date
```
---
## 📄 License
This project is licensed under the [MIT License](./LICENSE).