Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prmichaelsen/invoker
Execute bash commands using natural language.
https://github.com/prmichaelsen/invoker
Last synced: 5 days ago
JSON representation
Execute bash commands using natural language.
- Host: GitHub
- URL: https://github.com/prmichaelsen/invoker
- Owner: prmichaelsen
- Created: 2024-06-04T04:24:10.000Z (7 months ago)
- Default Branch: mainline
- Last Pushed: 2024-10-29T21:19:16.000Z (2 months ago)
- Last Synced: 2025-01-03T22:33:37.115Z (5 days ago)
- Language: TypeScript
- Size: 7.15 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
## Invoker
Execute bash commands using natural language.
#### Features
- `invoker` starts an interactive terminal emulator which accepts natural language
as input and executes a command that implements the intent of the input.
- Prefix input with `?` to enable confirmation before command execution.
- `invoker -f ` to execute immediately
- `invoker -fs ` to execute immediately and only output command results
#### Why use Invoker?
Invoker is nice when you need a command that you rarely use or that has non-straightforward syntax.
For instance, instead of typing:
```sh
find . type -f -name package.json -exec grep -l '@prmichaelsen' {} +
```
You can simply type:
```
Search this directory for a package.json that contains the text "@prmichaelsen"
```
Invoker will then construct a command designed to execute your intent, as demonstrated below.
## Installation & Setup
```sh
npm i -g @prmichaelsen/invoker
```
#### Initial Setup
Invoker is built on AWS Bedrock Claude Anthropic v2 and it requires CLI authentication with an AWS profile
authorized to call Bedrock in order to work. See the AWS docs on [CLI authentication](https://docs.aws.amazon.com/signin/latest/userguide/command-line-sign-in.html).
```sh
aws sso login --profile my-profile
```
If you aren't authenticated and authorized, Invoker will throw an error during usage.
#### Usage
##### Interactive Mode
```sh
invoker
Say Hi
echo Hi
Hi
```
Prompt to confirm before running:
```sh
invoker
? Say Hi
echo Hi (y/N)
y
Hi
```
#### Command Line Mode
```sh
invoker "Say Hi"
echo Hi
```
Pipe output:
```sh
invoker "Say Hi" | sh
Hi
```
Prompt to confirm before running:
```sh
invoker "? Say Hi"
echo Hi (y/N)
y
Hi
```
Run immediately:
```sh
invoker -f "Say Hi"
echo Hi
Hi
```
Run immediately and silently:
```sh
invoker -fs "Say Hi"
Hi
```
## Demos
### Hello World
### Command confirmation
Invoker supports command confirmation by prefixing your input
with `?`.
### Complex `git` workflow
With Invoker, you can focus on your
workflow and less on memorizing commands and flags.
### Miscellaneous
Invoker is very useful for commands that you do not often
have to run, such as `lsof -i`. It's not a difficult command to
remember, but if you only use it every few months, you'll find yourself
looking it up each time you need to use it.
Invoker is a great learning tool as well. It enables beginners
to effectively use the command line while also picking up
new commands along the way.
Invoker's use cases are innumerable. You can automate the most trivial of tasks with
very little effort.
## ⚠️ Warning
If you're not careful, Invoker can destroy your computer entirely.
**Never** use Invoker with `sudo`.
Use **extra caution** when executing any commands with side effects.
Make sure to prefix input with `?` as necessary.
Use at your own risk.
### Samples
