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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
# Nano Bots 💎 🤖
A Ruby implementation of the [Nano Bots](https://github.com/icebaker/nano-bots) specification.
_Image artificially created by Midjourney through a prompt generated by a Nano Bot specialized in Midjourney._
https://user-images.githubusercontent.com/113217272/237840989-1e29a5cc-6644-48d0-87b4-62798dc6ebd3.mp4
- [Setup](#setup)
- [Docker](#docker)
- [Usage](#usage)
- [Command Line](#command-line)
- [Library](#library)
- [Cartridges](#cartridges)
- [Development](#development)
- [Publish to RubyGems](#publish-to-rubygems)
## Setup
For a system usage:
```sh
gem install nano-bots -v 0.0.2
```
To use it in a project, add it to your `Gemfile`:
```ruby
gem 'nano-bots', '~> 0.0.2'
```
```sh
bundle install
```
For credentials and configurations, relevant environment variables can be set in your `.bashrc`, `.zshrc`, or equivalent files, as well as in your Docker Container or System Environment. Example:
```sh
export OPENAI_API_ADDRESS=https://api.openai.com
export OPENAI_API_ACCESS_TOKEN=your-token
export OPENAI_API_USER_IDENTIFIER=your-user
# export NANO_BOTS_STATE_DIRECTORY=/home/user/.local/state/nano-bots
# export NANO_BOTS_CARTRIDGES_DIRECTORY=/home/user/.local/share/nano-bots/cartridges
```
Alternatively, if your current directory has a `.env` file with the environment variables, they will be automatically loaded:
```sh
OPENAI_API_ADDRESS=https://api.openai.com
OPENAI_API_ACCESS_TOKEN=your-token
OPENAI_API_USER_IDENTIFIER=your-user
# NANO_BOTS_STATE_DIRECTORY=/home/user/.local/state/nano-bots
# NANO_BOTS_CARTRIDGES_DIRECTORY=/home/user/.local/share/nano-bots/cartridges
```
## Docker
Clone the repository and copy the Docker Compose template:
```
git clone git@github.com:icebaker/ruby-nano-bots.git
cd ruby-nano-bots
cp docker-compose.example.yml docker-compose.yml
```
Set your provider credentials and choose your desired directory for the cartridges files:
```yaml
version: '3.7'
services:
nano-bots:
image: ruby:3.2.2-slim-bullseye
command: sh -c "gem install nano-bots -v 0.0.2 && bash"
environment:
OPENAI_API_ADDRESS: https://api.openai.com
OPENAI_API_ACCESS_TOKEN: your-token
OPENAI_API_USER_IDENTIFIER: your-user
volumes:
- ./your-cartridges:/cartridges
# - ./your-data:/data
```
Enter the container:
```sh
docker compose run nano-bots
```
Start playing:
```sh
nb - - eval "hello"
nb - - repl
nb cartridges/assistant.yml - repl
nb cartridges/assistant.yml - eval "hello"
```
## Usage
### Command Line
After installing the gem, the `nb` binary command will be available for your project or system.
Examples of usage:
```bash
nb - - eval "hello"
# => Hello! How may I assist you today?
nb to-en-us-translator.yml - eval "Salut, comment ça va?"
# => Hello, how are you doing?
nb midjourney.yml - eval "happy cyberpunk robot"
# => A cheerful and fun-loving robot is dancing wildly amidst a
# futuristic and lively cityscape. Holographic advertisements
# and vibrant neon colors can be seen in the background.
nb lisp.yml - eval "(+ 1 2)"
# => 3
cat article.txt |
nb to-en-us-translator.yml - eval |
nb summarizer.yml - eval
# -> LLM stands for Large Language Model, which refers to an
# artificial intelligence algorithm capable of processing
# and understanding vast amounts of natural language data,
# allowing it to generate human-like responses and perform
# a range of language-related tasks.
```
```bash
nb - - repl
nb assistant.yml - repl
```
```text
🤖> Hi, how are you doing?
As an AI language model, I do not experience emotions but I am functioning
well. How can I assist you?
🤖> |
```
All of the commands above are stateless. If you want to preserve the history of your interactions, replace the `-` with a state key:
```bash
nb assistant.yml your-user eval "Salut, comment ça va?"
nb assistant.yml your-user repl
nb assistant.yml 6ea6c43c42a1c076b1e3c36fa349ac2c eval "Salut, comment ça va?"
nb assistant.yml 6ea6c43c42a1c076b1e3c36fa349ac2c repl
```
You can use a simple key, such as your username, or a randomly generated one:
```ruby
require 'securerandom'
SecureRandom.hex # => 6ea6c43c42a1c076b1e3c36fa349ac2c
```
### Library
To use it as a library:
```ruby
require 'nano-bots/cli' # Equivalent to the `nb` command.
```
```ruby
require 'nano-bots'
NanoBot.cli # Equivalent to the `nb` command.
NanoBot.repl(cartridge: 'cartridge.yml') # Starts a new REPL.
bot = NanoBot.new(cartridge: 'cartridge.yml')
bot.eval('Hello')
bot.repl # Starts a new REPL.
NanoBot.repl(cartridge: 'cartridge.yml', state: '6ea6c43c42a1c076b1e3c36fa349ac2c')
bot = NanoBot.new(cartridge: 'cartridge.yml', state: '6ea6c43c42a1c076b1e3c36fa349ac2c')
```
## Cartridges
Here's what a Nano Bot Cartridge looks like:
```yaml
---
meta:
name: Nano Bot Name
author: Your Name
version: 0.0.1
behaviors:
interaction:
directive: You are a helpful assistant.
provider:
name: openai
settings:
model: gpt-3.5-turbo
credentials:
address: ENV/OPENAI_API_ADDRESS
access-token: ENV/OPENAI_API_ACCESS_TOKEN
user-identifier: ENV/OPENAI_API_USER_IDENTIFIER
```
Check the Nano Bots specification to learn more about [how to build cartridges](https://icebaker.github.io/nano-bots/#/README?id=cartridges).
## Development
```bash
bundle
rubocop -A
rspec
```
### Publish to RubyGems
```bash
gem build nano-bots.gemspec
gem signin
gem push nano-bots-0.0.2.gem
```
|
