Coder Social home page Coder Social logo

chewkeanho / app_hiai Goto Github PK

View Code? Open in Web Editor NEW
3.0 1.0 0.0 38.17 MB

A local terminal polygot (POSIX Shell x PowerShell) bridging LLM AI prompt interaction capabilities directly to your computer!

License: Apache License 2.0

Shell 53.87% PowerShell 42.78% Rich Text Format 3.16% Roff 0.19%
ai-application ai-prompt-app curl powershell shell

app_hiai's Introduction

Holloway's HiAI

hollowayHIAI

A local terminal polygot (POSIX Shell x PowerShell) bridging LLM AI prompt interaction capabilities directly to your computer!

Turn every computer's terminal into an interactive AI prompt.

hollowayHIAI-demo-debian

Important

Special thanks to Google for sponsoring its Google Gemini Advanced Ultra services allowing this app to be possibly realized.

Why It Matters

Some good business reasons why using AutomataCI:

  1. Use AI prompt straight from the terminal - No need to visit here and there just to use AI prompt.
  2. Simple and straight forward - Frankly, it's created to resolve some AI prompt's buggy UI.
  3. Steadily improvable - Will continue to improve over time.
  4. Programmable - I'm so done with copy-pasting prompt constructors.

Supported AI Vendors

  1. Google AI - Get API Token

To Install

The software is packaged based on available OSes.

Debian based OSes (linux, hurd, etc)

  1. Download the latest .deb package from the release section.
  2. perform $ dpkg -i <package>.deb.

Don't worry, the package will setup the upstream apt repository list source alongside the required GPG key for future apt update.

Red Hat based Linux OS (redhat, fedora, etc)

  1. Download the latest .rpm package from the release section.
  2. perform $ rpm -i <package>.rpm.

Don't worry, the package will setup the upstream yum repository list source alongside the required GPG key for future yum update.

Flatpak

  1. Download the latest .flatpak package from the release section.
  2. perform $ flatpak --user install <package>.flatpak.

Note that the command to use is: flatpak run com.github.chewkeanho.app_hiai ... due to how Flatpak works. For example, to get help, it is:

$ flatpak run com.github.chewkeanho.app_hiai --help

For direct installation in FlatHub, it's still work in progress.

Homebrew (MacOS)

NOTE: One time Setup - add the ChewKeanHo's Collections Tap.

$ brew tap chewkeanho/collections https://github.com/ChewKeanHo/Collections.git

Install Holloway's HiAI!

$ brew install hollowayhiai

That's it.

Chocolatey (Windows)

Coming Soon

Docker / Podman

The container distribution is hosted on GitHub Packages. Please keep in mind that the packages section is continuously updated with development so the catalog can be confusing (e.g. you may see some development images before release).

To pull an image with Docker, the command is as follows:

$ docker pull ghcr.io/chewkeanho/hollowayhiai:latest

# OR

# $ docker pull ghcr.io/chewkeanho/hollowayhiai:[VERSION]
# Example for `v0.0.2`:
$ docker pull ghcr.io/chewkeanho/hollowayhiai:0.0.2

To run with Docker, you need to mount your config file and execute using the ARGS environment variables. The --config argument MUST match with the pathing you mounted to (target=). For example:

# note - '-it' must always be the last argument
$ docker run --env ARGS="--config /CONFIG.toml --text2text 'Who are you?'" \
	--mount type=bind,source="/path/to/CONFIG.toml",target="/CONFIG.toml" \
	-it ghcr.io/chewkeanho/hollowayhiai:[VERSION]


# to call for help
$ docker run --env ARGS="--help" ghcr.io/chewkeanho/hollowayhiai:[VERSION]

Plain Script

Use the tar.gz package or zip package on Windows OS.

Note that the command to use is: hollowayhiai_[OS]-[ARCH].sh.ps1 (with file extensions) instead of the guided hollowayHIAI since you're executing directly from the script.

How-tos, Documentations & Specifications

To use Holloway's HiAI, you need to first setup 1-time CONFIG.toml file:

# UNIX (Linux & MacOS) - POSIX Shell
$ hollowayHIAI --create-config path/to/file.toml

# WINDOWS - PowerShell
$ powershell.exe -noprofile `
	-executionpolicy bypass `
	-Command "& .\hollowayhiai_windows-[ARCH].sh.ps1 --create-config 'path\to\file.toml'"


# update the path/to/file.toml especially with the API token.

Once done, you may proceed to execute it:

# UNIX (Linux & MacOS) - POSIX Shell
$ hollowayHIAI --config path/to/file.toml --text2text "...your prompt..."


# WINDOWS - PowerShell
$ powershell.exe -noprofile `
	-executionpolicy bypass `
	-Command "& .\hollowayhiai_windows-[ARCH].sh.ps1 --config path\to\file.toml --text2text `"...your prompt...`""

In any cases, if you need any on-screen assistances:

# UNIX (Linux & MacOS) - POSIX Shell
$ hollowayHIAI --help


# WINDOWS - PowerShell
$ powershell.exe -noprofile `
	-executionpolicy bypass `
	-Command "& .\hollowayhiai_windows-[ARCH].sh.ps1 --help"

To Contribute

Holloway's HiAI! cannot be made successfully without contributions from (Holloway) Chew, Kean Ho, his teams, and supports from external folks. If you had been using it and wish to contribute back, there are 2 ways to do so:

Financial

To financially support the project, please head over to Holloway's sponorship store here:

Sponsor

A small token purchase would helps a lot.

Craftmanship

If you wish to bring in codes contribution, bug report, and ideas, please feel free to refer the PDF Handbook and execute accordingly.

License

Holloway's HiAI! is licensed under OSI compatible Apache 2.0 License.

app_hiai's People

Contributors

hollowaykeanho avatar

Stargazers

Ant avatar  avatar Galyna, Cory avatar

Watchers

 avatar

app_hiai's Issues

Enable Docker Run

Description

Currently Docker is built but untested. Let's make sure it's usable and document the "how-to"

Expected Behavior

Docker is now operational.

Current Behavior

Docker is not operational.

Associated Data Files

No response

Enable Homebrew Install

Description

Make sure brew can install from the Collection repository.

Expected Behavior

brew is able to install hollowayHIAI.

Current Behavior

brew is unavailable.

Associated Data Files

No response

Intitialize version v0.0.1

Description

Begin the project. Initialize version v0.0.1 with the first prototype.

Expected Behavior

project is initialized.

Current Behavior

project is not initialized.

Associated Data Files

No response

Enable Chocolatey Install

Description

Chocolatey was not available for install. Let's enable it.

Expected Behavior

choco install is now available.

Current Behavior

choco install is unavailable.

Associated Data Files

No response

Fix help typo

Description

Help has a typo with the --text2text argument explanation. Please fix it.

Expected Behavior

--text2text [STRING] operate text-to-text prompt.

Current Behavior

--text2-text [STRING] operate text-to-text prompt.

Steps to Reproduce [COMPULSORY]

  1. run --help and observe.

Associated Data Files

No response

Update Flatpak Use & Install instruction.

Description

Since Flatpak is a chicken and egg situation that requires releases before testing, let's update the use and install instructions on the README.md.

Page URL Address

No response

Expected Presentation

Flatpak has install and use instruction.

Current Behavior

Flatpak does not have install & use instruction.

Associated Data Files

No response

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.