Skip to main content

An AI-powered natural-language Linux assistant

Project description

linux‑Assistant

An AI-powered assistant that lets you interact with your Linux system using natural language. Ask it to list files, install packages, inspect processes, or perform any shell task—behind the scenes it translates your request into safe bash commands and runs them for you.


Features

  • Natural‑language interface: Describe what you want to do—no need to remember exact commands.
  • Interactive shell execution: The assistant decides when to run commands, executes them in a temporary script, and returns the output.
  • Continuous conversation: You can follow up on results, ask for clarifications, or chain multiple operations in one session.
  • Customizable: Swap in any llama.cpp model and adjust prompts to suit your workflow.

Prerequisites

  • Linux
  • Python 3.12+
  • (Optional but recommended) A dedicated Python virtual environment

Configuration

Open models/config.py and adjust:

  • GENERATION_MODEL – the GGUF model you wish to use.
  • REPO_ID – The hf repository you want to model beeing download from.
  • SYSTEM_PROMPT – how the assistant should frame its replies and decide when to run shell commands.

Installation

  • Install via pip
$ pip install linux-assistant
  • Build from source
$ git clone https://github.com/alifthi/linux-Assistant.git
$ cd linux-Assistant
$ pip install -e .

Usage

Run the assistant and start chatting:

$ linux-assistant
  • If inference enginee is not installed, you need to run linux-assistant setup to install inference enginee.

  • Ask anything you would normally do in the terminal.

  • Continue the conversation naturally or type exit to quit.


Run the assistant using Docker

docker run --name <Container's name> \
   -v linux_assistant_volume:/app/data \
   -v "$(pwd)":/app/workspace alifthi/linux-assistant 

Contributing

Contributions and feedback are welcome! Feel free to:

  • Open issues for bugs or feature requests
  • Submit pull requests to improve prompts, handling, or documentation
  • Suggest new use cases or integrations

License

Distributed under the MIT License. See LICENSE for details.

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

linux_assistant-0.1.3.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

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

linux_assistant-0.1.3-py3-none-any.whl (13.4 kB view details)

Uploaded Python 3

File details

Details for the file linux_assistant-0.1.3.tar.gz.

File metadata

  • Download URL: linux_assistant-0.1.3.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.2

File hashes

Hashes for linux_assistant-0.1.3.tar.gz
Algorithm Hash digest
SHA256 218158d4e89a2aa022116b7b1a09dbf53d7f917881080bf00d56d9315db2f93d
MD5 806b62236cd749e8eb0e78ea70a83624
BLAKE2b-256 a42559df2dde3f617acf9c99f084ac0ddc400f8c50a66206d41f4718e4b3efdd

See more details on using hashes here.

File details

Details for the file linux_assistant-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for linux_assistant-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 49ba843c1885725423217c2573dde80402b33a42cad19689f63e0dcdf90d3668
MD5 9c6e6b5231328720f3e8db0597435457
BLAKE2b-256 11dfeac53158b5c869431b24c803ab2f681921aea501050a5f70fc22f2cf99ff

See more details on using hashes here.

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