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
|
# Nano Bots 💎 🤖
A Ruby implementation of the [Nano Bots](https://github.com/icebaker/nano-bots) specification.
- [Setup](#setup)
- [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.1
```
To use it in a project, add it to your `Gemfile`:
```ruby
gem 'nano-bots', '~> 0.0.1'
```
```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
OPENAI_API_ADDRESS=https://api.openai.com
OPENAI_API_ACCESS_TOKEN=your-token
OPENAI_API_USER_IDENTIFIER=your-user
NANO_BOTS_STATE_DIRECTORY=/home/your-user/.local/state/nano-bots
NANO_BOTS_CARTRIDGES_DIRECTORY=/home/your-user/.local/share/nano-bots/cartridges
```
Alternatively, if your current directory has a `.env` file with the environment variables, they will be automatically loaded.
## Usage
### Command Line
After installing the gem, the `rnb` binary command will be available for your project or system.
Examples of usage:
```bash
rnb to-en-us-translator.yml - eval "Salut, comment ça va?"
# => Hello, how are you doing?
rnb midjourney.yml - eval "happy and friendly cyberpunk robot"
# => The robot exploring a bustling city, surrounded by neon lights
# and high-rise buildings. The prompt should include colorful
# lighting and a sense of excitement in the facial expression.
rnb lisp.yml - eval "(+ 1 2)"
# => 3
cat article.txt |
rnb to-en-us-translator.yml - eval |
rnb 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
rnb assistant.yml - repl
```
All of the commands above are stateless. If you want to preserve the history of your interactions, replace the `-` with a state key. You can use a simple key, such as your username, or a randomly generated one:
```ruby
require 'securerandom'
SecureRandom.hex # => 6ea6c43c42a1c076b1e3c36fa349ac2c
```
```bash
rnb assistant.yml your-user eval "Salut, comment ça va?"
rnb assistant.yml your-user repl
rnb assistant.yml 6ea6c43c42a1c076b1e3c36fa349ac2c eval "Salut, comment ça va?"
rnb assistant.yml 6ea6c43c42a1c076b1e3c36fa349ac2c repl
```
### Library
To use it as a library:
```ruby
require 'nano-bots/cli' # Equivalent to the `rnb` command.
```
```ruby
require 'nano-bots'
NanoBot.cli # Equivalent to the `rnb` 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
---
name: Assistant
version: 0.0.1
behaviors:
interaction:
directive: You are a helpful assistant.
interfaces:
repl:
prompt:
- text: '🤖'
- text: '> '
color: blue
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.1.gem
```
|
