task-sh 0.1.1

AI-powered shell command generator
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

# task.sh

[![Crates.io](https://img.shields.io/crates/v/task-sh.svg)](https://crates.io/crates/task-sh)
[![CI](https://github.com/barledge/task.sh/actions/workflows/rust.yml/badge.svg)](https://github.com/barledge/task.sh/actions)

`task.sh` turns natural language task descriptions into safe shell command suggestions using OpenAI. The CLI is designed for cross-platform usage (Linux, macOS) and emphasizes safety, observability, and customization.

## Features

- `task gen` subcommand with `--shell` selection (`bash`, `zsh`).
- Verbose mode prints raw AI output and explanations.
- Regex-based command safety filters.
- Optional `TASK_SH_FAKE_RESPONSE` environment variable for deterministic tests.

## Getting Started

### Prerequisites

- Rust toolchain (via [rustup](https://rustup.rs/)).
- OpenAI API key with access to GPT-3.5 (or compatible) models.

### Installation

```bash
git clone https://github.com/barledge/task.sh.git
cd task.sh
cargo install --path .
cp .env.example .env
```

Edit `.env` and set `OPENAI_API_KEY` to your secret key.

### Usage

```bash
# Generate a bash command with explanation
task gen "list large files" --shell bash -v

# Pipe input via stdin
echo "list staged changes" | task gen --verbose

# Use the fake response mode for testing/demos
TASK_SH_FAKE_RESPONSE=$'Command: ls\nExplanation: list files' task gen "anything"
```

Inspect all options:

```bash
sh --help
```

## Environment

- `OPENAI_API_KEY`: Required for live generation.
- `TASK_SH_FAKE_RESPONSE`: Optional string that substitutes the OpenAI response for testing.

## Development

```bash
cargo fmt
cargo clippy --all-targets
cargo test
```

## Build Scripts

```bash
scripts/build-release.sh
scripts/publish.sh
```

For cross-compilation (requires `cargo-zigbuild`):

```bash
scripts/build-cross.sh x86_64-unknown-linux-gnu
scripts/build-cross.sh x86_64-pc-windows-gnu
scripts/build-cross.sh aarch64-apple-darwin
```

## Documentation

The mdBook-based docs live in `docs/`.

```bash
cargo install mdbook
mdbook build docs
```

Publish to `task.sh/docs` or serve locally with `mdbook serve docs`.

## Contributing

1. Fork the repository and create a feature branch.
2. Add tests covering new functionality.
3. Run `cargo fmt`, `cargo clippy`, and `cargo test` before submitting a PR.
4. Submit a PR with a concise description of the changes.

## License

Licensed under the MIT License.