Skip to main content

LocalAssistant (locas) is an AI designed to be used in CLI. (Currently in development)

Project description

LocalAssistant

Locas - your local assistant

icon

Your CLI friend.


>> locas -h

usage: locas [-h] [-v] [-V] COMMAND ...

LocalAssistant (locas) is an AI designed to be used in CLI.

options:
  -h, --help          show this help message and exit
  -v, --verbose       show debug messages (Can be used multiple times for higher level: CRITICAL[v] -> DEBUG[vvvv])
  -V, --version       show program's version number and exit

commands:
  built-in commands (type 'locas COMMAND -h' for better description).

  COMMAND
    download          Download models from Hugging Face
    config            Configurate LocalAssistant.
    user              Config user.
    chat              Chat with models for limited lines. (no history saved)
    start             Chat with models using history.
    docs              Ask information from provided documents.
    self-destruction  LocalAssistant's self-destruction.

Installing

Download locas_installer.py, and let magic happens.

python3 locas_installer.py

Let's try if it works:

locas.cmd -h

Preparing

To chat, we will need model! You can download other models you want. Below is my recommend for first use (Like a starter pack.)

For text generation: (Choose other models from here.)

locas.cmd download -n qwen Qwen/Qwen2.5-1.5B-Instruct 1

For sentence transformer: (Choose other models from here.)

locas.cmd download -n minilm sentence-transformers/all-MiniLM-L6-v2 2

For cross encoder: (Choose other models from here.)

locas.cmd download -n msmarco cross-encoder/ms-marco-MiniLM-L-6-v2 3

Running

By default, locas works at most of the time:

(Unix user may try locas.cmd ... first. Window user can use both locas and locas.cmd)

locas ...

Learn more about useful functions:

locas -h

To deactivate: (It uses python's virtual environment)

deactivate

Removing

locas self-destruction

License

GNU GPLv3


Disclaimer

This AI was designed to communicating with Hugging Face models in CLI. Please do not use this AI for any unethical reasons. Any damages from abusing this application will not be the responsibility of the author.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

localassistant-1.1.1.tar.gz (33.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

LocalAssistant-1.1.1-py3-none-any.whl (38.2 kB view details)

Uploaded Python 3

File details

Details for the file localassistant-1.1.1.tar.gz.

File metadata

  • Download URL: localassistant-1.1.1.tar.gz
  • Upload date:
  • Size: 33.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for localassistant-1.1.1.tar.gz
Algorithm Hash digest
SHA256 d30aa68e339503a27cb6e163be5c993454db986456cc859cf2dd33cc535aef6a
MD5 1adb22bef882aefaf526336ca28ef7c5
BLAKE2b-256 98554f47c97ebd761b9086ef87fd461cadb35cf49c9246b87ee2e09fb5485e25

See more details on using hashes here.

Provenance

The following attestation bundles were made for localassistant-1.1.1.tar.gz:

Publisher: python-publish.yml on Linos1391/LocalAssistant

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file LocalAssistant-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: LocalAssistant-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 38.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for LocalAssistant-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 953257c706bc116f5eb4904081385cff69da163805d54beac8a1bde1e4390bff
MD5 05aa15c5ef634a00fdcc4546b2bf663c
BLAKE2b-256 d231f978c548e6d18a07665535a41a52b78a697fe1c8e04df5efb315ac0930b7

See more details on using hashes here.

Provenance

The following attestation bundles were made for LocalAssistant-1.1.1-py3-none-any.whl:

Publisher: python-publish.yml on Linos1391/LocalAssistant

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page