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 setupto install inference enginee. -
Ask anything you would normally do in the terminal.
-
Continue the conversation naturally or type
exitto 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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file linux_assistant-0.1.2.tar.gz.
File metadata
- Download URL: linux_assistant-0.1.2.tar.gz
- Upload date:
- Size: 11.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4949eb2571f41e080298de046bb34b7fb38ad7caf1fa1ccdfab334d823b7e6f1
|
|
| MD5 |
e08cc75186eebd9d6c309906fb1dce37
|
|
| BLAKE2b-256 |
5f951da5a6e992015e3349945959c3c6a97e446c6c38191632c54f623c967a40
|
File details
Details for the file linux_assistant-0.1.2-py3-none-any.whl.
File metadata
- Download URL: linux_assistant-0.1.2-py3-none-any.whl
- Upload date:
- Size: 12.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ed542c9b4db21a8b0cb17051fe6efe9d916da1f9df4abc64875f67df1bbc9784
|
|
| MD5 |
a06172481cdf862ca1e3c6d3c4a82384
|
|
| BLAKE2b-256 |
3a9715eb9676b479bfaa5c77a7338b58b23e59d06aed7d1693503c34114c25bc
|