https://github.com/artbit/bash-intents

Ultra simple natural language processing in bash
https://github.com/artbit/bash-intents

bash bash-scripting natural-language-processing nlp nlp-parsing

Last synced: about 2 months ago
JSON representation

Ultra simple natural language processing in bash

• Host: GitHub
• URL: https://github.com/artbit/bash-intents
• Owner: ArtBIT
• License: mit
• Created: 2023-11-21T07:23:54.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-21T18:24:31.000Z (about 1 year ago)
• Last Synced: 2024-10-13T01:29:00.334Z (3 months ago)
• Topics: bash, bash-scripting, natural-language-processing, nlp, nlp-parsing
• Language: Shell
• Homepage:
• Size: 14.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bash-Intents

[![GitHub license](https://img.shields.io/github/license/ArtBIT/bash-intents.svg)](https://github.com/ArtBIT/bash-intents) [![GitHub stars](https://img.shields.io/github/stars/ArtBIT/bash-intents.svg)](https://github.com/ArtBIT/bash-intents)  [![awesomeness](https://img.shields.io/badge/awesomeness-maximum-red.svg)](https://github.com/ArtBIT/bash-intents)

Ultra simple natural language processing in bash

# Purpose

The general purpose of Bash Intents is to simplify natural language interaction in the command line. It uses regular expressions to match input text to an intent file. The intent files are located in the `./intents` subdirectory, and they simply define the `intent_regex` array of regex rules and an `intent_handler` function to run if the intent is matched.

I have a smart microphone [ATOM Echo Smart Speaker](https://shop.m5stack.com/products/atom-echo-smart-speaker-dev-kit) and I needed a way to map spoken word into script actions, so I've built this.

It's a glorified regex mapper. For each intent (which is a file in the `./intents` subdirectory(, you define a list of regex rules, and a handler. A minimal intent file would look like this:

```

# ./intents/hello-world

intent_regex=(

    "My name is " 

)

intent_handler() {

    local sentence="$1"

    eval "$2" # expands the named capture groups to bash variables

              #  from the intent_regex will be available as $name here

    # we can save the value in the `./state.vars` file

    set_state "name" "$name" 

    case "$name" in

        world)

            echo "Hello World!"

            ;;

        *)

            echo "Hello, $name"

    esac

}

```

Then, you would just say:

```

./bash-intents.sh My name is world.

# and you would get the following response

Hello World!

```

Check the [./intents](./intents) subdirectory, to see more examples.

# Installation

```

$> git clone https://github.com/ArtBIT/bash-intents.git

# Alias it to, say, computer, alexa, jarvis, etc.

$> echo alias computer="$PWD/bash-intents/bash-intents.sh" >> "$HOME/.bashrc"

```

# Usage

```

$> computer start the demo 

# It stores a state value in `state.vars`

# Check the ./intents/activate intent_handler to see what the demo does

$> computer what is the status of the demo?

# It reads a state value from `state.vars`

The demo is running.

$> computer stop the demo

# It updates a state value in `state.vars`

$> computer what is the status of the demo?

The demo is not running.

# It reads a state value from `state.vars`

# starting/stopping/statuses for services in /etc/init.d/* are built in

$> computer what is the status of bluetooth?

The bluetooth is running

$> computer what is the status of cron?

The cron is running

```

You can add more intents by creating a new intent file in the `intents` subdirectory.

You can specify your own `intents` directory using the `$BASH_INTENTS_DIR` environment variable. 

```

export BASH_INTENTS_DIR=$HOME/intents

```

[![asciicast](https://asciinema.org/a/LbNOgxhO1fuNRgI1eOM3nyZrd.svg)](https://asciinema.org/a/LbNOgxhO1fuNRgI1eOM3nyZrd)

# License

[MIT](LICENSE.md)