Metadata-Version: 2.1
Name: futureos
Version: 0.1.0
Summary: A command-line interface (CLI) tool for managing and executing various shell commands with enhanced features.
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: chromadb >=0.5.18
Requires-Dist: langchain-community >=0.3.5
Requires-Dist: langchain-ollama >=0.2.0
Requires-Dist: langchain >=0.3.7
Requires-Dist: loguru >=0.7.2
Requires-Dist: ollama >=0.3.3
Requires-Dist: pytest >=8.3.3
Requires-Dist: rich >=13.9.4

# futureOS

futureOS is a command-line interface (CLI) tool for managing and executing various shell commands with enhanced features. It leverages advanced libraries like `chromadb`, `langchain`, and `rich` to provide a powerful and user-friendly experience.

## Features

- Execute shell commands with natural language queries.
- Enhanced command matching using embeddings.
- Rich output formatting with `rich`.
- Logging with `loguru`.

## Installation

To install futureOS, ensure you have Python 3.12 or higher and use the `uv` packaging tool:

```sh
uv install futureos
```

## Usage

After installation, you can start the CLI by running:

```sh
python -m futureos
```

### Available Commands

- `help`: Show help for all commands or a specific command.
- `exit`/`quit`: Exit the shell.

### Example

```sh
$ python -m futureos
Type 'help' for available commands

$ /home $ ls
# Lists the files in the current directory

$ /home $ cat /home/finances.csv
# Displays the content of the file 'finances.csv'
```

## Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

## License

This project is licensed under the MIT License.
