asimov-openai-module 0.0.3

ASIMOV OpenAI module.
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
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
102
103
104
105

# ASIMOV OpenAI Module

[![License](https://img.shields.io/badge/license-Public%20Domain-blue.svg)](https://unlicense.org)
[![Package on Crates.io](https://img.shields.io/crates/v/asimov-openai-module)](https://crates.io/crates/asimov-openai-module)
[![Documentation](https://docs.rs/asimov-openai-module/badge.svg)](https://docs.rs/asimov-openai-module)

[ASIMOV] OpenAI module.

## ✨ Features

- To be determined!

## 🛠️ Prerequisites

- [Rust] 1.85+ (2024 edition) if building from source code

## ⬇️ Installation

### Installation with [ASIMOV CLI]

```bash
asimov module install openai -v
```

### Installation from Source Code

```bash
cargo install asimov-openai-module
```

## 👉 Examples

```bash
asimov-openai-prompter
```

## ⚙ Configuration

Provide an API key either by module configuration

```bash
asimov module config openai
```

Or through environment variables

```bash
export OPENAI_API_KEY="..."
```

### Optional configuration

| Name       | Environment Variable  | Default                  |
| ---------- | --------------------- | ------------------------ |
| `endpoint` | `OPENAI_API_ENDPOINT` | `https://api.openai.com` |
| `model`    | `OPENAI_MODEL`        | `gpt-5-mini`             |

### Use a custom endpoint such as [Exo](https://github.com/exo-explore/exo)

```console
$ # either:
$ asimov module config openai
Enter value for `api-key`
> doesntmatter
Enter value for `endpoint` (optional, default: `https://api.openai.com`)
> http://localhost:52415
Enter value for `model` (optional, default: `gpt-5-mini`)
> llama-3.2-3b

$ # or:
$ export OPENAI_API_ENDPOINT="http://localhost:52415"
$ export OPENAI_MODEL="llama-3.2-3b"

$ # then:
$ echo "Why is the sky blue?" | asimov-openai-prompter
```

## 📚 Reference

### Prompt

```bash
echo "Why is the sky blue?" | asimov-openai-prompter
```

## 👨‍💻 Development

```bash
git clone https://github.com/asimov-modules/asimov-openai-module.git
```

---

[![Share on X](https://img.shields.io/badge/share%20on-x-03A9F4?logo=x)](https://x.com/intent/post?url=https://github.com/asimov-modules/asimov-openai-module&text=asimov-openai-module)
[![Share on Reddit](https://img.shields.io/badge/share%20on-reddit-red?logo=reddit)](https://reddit.com/submit?url=https://github.com/asimov-modules/asimov-openai-module&title=asimov-openai-module)
[![Share on Hacker News](https://img.shields.io/badge/share%20on-hn-orange?logo=ycombinator)](https://news.ycombinator.com/submitlink?u=https://github.com/asimov-modules/asimov-openai-module&t=asimov-openai-module)
[![Share on Facebook](https://img.shields.io/badge/share%20on-fb-1976D2?logo=facebook)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/asimov-modules/asimov-openai-module)
[![Share on LinkedIn](https://img.shields.io/badge/share%20on-linkedin-3949AB?logo=linkedin)](https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/asimov-modules/asimov-openai-module)

[ASIMOV]: https://asimov.sh
[ASIMOV CLI]: https://cli.asimov.sh
[JSON-LD]: https://json-ld.org
[KNOW]: https://know.dev
[RDF]: https://www.w3.org/TR/rdf12-primer/
[Rust]: https://rust-lang.org