ulm 0.3.2

AI-powered manpage assistant using local LLM
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

# ulm - Der ULMer

[![CI](https://github.com/elmar-roeser/ulm/actions/workflows/ci.yml/badge.svg)](https://github.com/elmar-roeser/ulm/actions/workflows/ci.yml)
[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue)](LICENSE-MIT)
[![Rust](https://img.shields.io/badge/rust-1.70%2B-orange)](https://www.rust-lang.org/)

AI-powered manpage assistant using local LLM inference.

## Overview

ulm transforms CLI interaction from "memorize commands" to "describe intent." It's an AI-powered bridge between what users want to accomplish and the thousands of powerful but cryptic Unix tools available on their system.

## Features

- **Discovery** - Finds the right tool even when you don't know it exists
- **Education** - Explains WHY each flag works, not just WHAT to type
- **Efficiency** - Zero context switching, all in the terminal
- **Privacy** - All processing occurs locally using Ollama

## Installation

```bash
cargo install ulm
```

### Prerequisites

- [Ollama](https://ollama.ai) installed and running
- `man` command available (man-db)

## Usage

```bash
# Initialize ulm with Ollama and index manpages
ulm setup

# Ask a question
ulm "find large files in current directory"

# Update manpage index
ulm update
```

## Development

```bash
# Build
cargo build

# Run tests
cargo test

# Run with logging
RUST_LOG=ulm=debug cargo run -- "your query"
```

## License

Licensed under either of

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

## Contributing

Contributions are welcome! Please follow [Conventional Commits](https://www.conventionalcommits.org/) for commit messages.