Skip to content

Commit af5d1c6

Browse files
codergeek121codergeek121
committed
inital prototype
0 parents  commit af5d1c6

27 files changed

+603
-0
lines changed

‎.github/workflows/main.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Ruby
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
pull_request:
9+
10+
jobs:
11+
build:
12+
runs-on: ubuntu-latest
13+
name: Ruby ${{ matrix.ruby }}
14+
strategy:
15+
matrix:
16+
ruby:
17+
- '3.0.2'
18+
19+
steps:
20+
- uses: actions/checkout@v3
21+
- name: Set up Ruby
22+
uses: ruby/setup-ruby@v1
23+
with:
24+
ruby-version: ${{ matrix.ruby }}
25+
bundler-cache: true
26+
- name: Run the default task
27+
run: bundle exec rake

‎.gitignore

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/.bundle/
2+
/.yardoc
3+
/_yardoc/
4+
/coverage/
5+
/doc/
6+
/pkg/
7+
/spec/reports/
8+
/tmp/

‎CONTRIBUTING.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing
2+
3+
The following topics are missing for a 1.0.0 release:
4+
5+
```
6+
* Allow adding "personas" to the config ([see here](docs/personas.md))
7+
* Rewrite with tests as soon as the basic prototype is useful
8+
* Add GitHub Actions for PRs
9+
* Build a landing page
10+
```
11+
12+
Please use `clai` and contribute here on GitHub. I'm open to all suggestions and improvements.
13+
14+
0.x.x versions don't need tests or extensive documentation. Adding a small description will help me understand your change though :)
15+
16+
Please open a PR with a short description of your use-case and I will review and merge.
17+
18+
Thank you,
19+
Niklas

‎Gemfile

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# frozen_string_literal: true
2+
3+
source "https://rubygems.org"
4+
5+
# Specify your gem's dependencies in clai.gemspec
6+
gemspec
7+
8+
gem "rake", "~> 13.0"
9+
10+
gem "minitest", "~> 5.0"
11+
12+
gem "debug", ">= 1.0.0"

‎Gemfile.lock

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
PATH
2+
remote: .
3+
specs:
4+
clai (0.1.0)
5+
http (~> 5.1, >= 5.1.1)
6+
thor (~> 1.2, >= 1.2.2)
7+
zeitwerk (~> 2.6, >= 2.6.8)
8+
9+
GEM
10+
remote: https://rubygems.org/
11+
specs:
12+
addressable (2.8.4)
13+
public_suffix (>= 2.0.2, < 6.0)
14+
debug (1.8.0)
15+
irb (>= 1.5.0)
16+
reline (>= 0.3.1)
17+
domain_name (0.5.20190701)
18+
unf (>= 0.0.5, < 1.0.0)
19+
ffi (1.15.5)
20+
ffi-compiler (1.0.1)
21+
ffi (>= 1.0.0)
22+
rake
23+
http (5.1.1)
24+
addressable (~> 2.8)
25+
http-cookie (~> 1.0)
26+
http-form_data (~> 2.2)
27+
llhttp-ffi (~> 0.4.0)
28+
http-cookie (1.0.5)
29+
domain_name (~> 0.5)
30+
http-form_data (2.3.0)
31+
io-console (0.6.0)
32+
irb (1.7.1)
33+
reline (>= 0.3.0)
34+
llhttp-ffi (0.4.0)
35+
ffi-compiler (~> 1.0)
36+
rake (~> 13.0)
37+
minitest (5.18.1)
38+
public_suffix (5.0.1)
39+
rake (13.0.6)
40+
reline (0.3.5)
41+
io-console (~> 0.5)
42+
thor (1.2.2)
43+
unf (0.1.4)
44+
unf_ext
45+
unf_ext (0.0.8.2)
46+
zeitwerk (2.6.8)
47+
48+
PLATFORMS
49+
arm64-darwin-21
50+
51+
DEPENDENCIES
52+
clai!
53+
debug (>= 1.0.0)
54+
minitest (~> 5.0)
55+
rake (~> 13.0)
56+
57+
BUNDLED WITH
58+
2.4.16

‎README.md

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# ChatGPT/OpenAI in your terminal - CLAI
2+
3+
CLAI (CLI + AI = CLAI) allows you to interact with the OpenAI API in your terminal.
4+
5+
## Installation
6+
7+
First, ensure that you have Ruby installed on your system. Then, you can install the gem by running:
8+
9+
```
10+
$ gem install clai
11+
```
12+
13+
## Configuration
14+
15+
Before using the CLI tool, you need to configure it with your OpenAI API key. You can obtain an API key from the OpenAI website. Once you have your API key, run the following command and provide your key when prompted:
16+
17+
```
18+
$ clai setup
19+
```
20+
21+
This will create a configuration file (`~/.config/clai/clai.yml`) on your system.
22+
23+
Read more about the setup command [here](docs/setup.md).
24+
25+
## Usage
26+
27+
You can chat with ChatGPT with:
28+
29+
```
30+
$ clai chat "Tell me a funny joke"
31+
```
32+
33+
This will send the given prompt to the API and display the generated completion.
34+
35+
### Help
36+
37+
To view the available commands and options, you can use the `help` command:
38+
39+
```
40+
$ clai help
41+
```
42+
43+
This will display a list of supported commands and their descriptions.
44+
45+
### Starting a session
46+
47+
You can start an interactive session with `clai session` command.
48+
49+
```
50+
$ clai session
51+
Your prompt: <Enter your prompt here><Enter>
52+
```
53+
54+
This will start a REPL like process to interact with the OpenAI api.
55+
56+
## Examples
57+
58+
Here are a few examples to get you started:
59+
60+
```sh
61+
# Setup clai on your machine
62+
$ clai setup
63+
64+
# Start an interactive chat session
65+
$ clai session
66+
67+
# Get help about the available commands and options
68+
$ clai help
69+
70+
# Send a single prompt
71+
$ clai chat "Hello World"
72+
```
73+
74+
## Contributing
75+
76+
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
77+
78+
## Disclaimer
79+
80+
This is alpha software. Make sure to set a billing limit for your api key or unexpected costs will occur.
81+
82+
## License
83+
84+
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).

‎Rakefile

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# frozen_string_literal: true
2+
3+
require "bundler/gem_tasks"
4+
require "rake/testtask"
5+
6+
Rake::TestTask.new(:test) do |t|
7+
t.libs << "test"
8+
t.libs << "lib"
9+
t.test_files = FileList["test/**/test_*.rb"]
10+
end
11+
12+
task default: :test

‎bin/console

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#!/usr/bin/env ruby
2+
# frozen_string_literal: true
3+
4+
require "bundler/setup"
5+
require "clai"
6+
7+
# You can add fixtures and/or initialization code here to make experimenting
8+
# with your gem easier. You can also use a different console, if you like.
9+
10+
require "irb"
11+
IRB.start(__FILE__)

‎bin/setup

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#!/usr/bin/env bash
2+
set -euo pipefail
3+
IFS=$'\n\t'
4+
set -vx
5+
6+
bundle install
7+
8+
# Do any other automated setup that you need to do here

‎clai.gemspec

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# frozen_string_literal: true
2+
3+
require_relative "lib/clai/version"
4+
5+
Gem::Specification.new do |spec|
6+
spec.name = "clai"
7+
spec.version = CLAI::VERSION
8+
spec.authors = ["Niklas Häusele"]
9+
spec.email = ["[email protected]"]
10+
11+
spec.summary = "Your personal AI for the terminal"
12+
spec.description = spec.summary
13+
spec.homepage = "https://github.com/codergeek121/clai"
14+
spec.required_ruby_version = ">= 2.6.0"
15+
16+
spec.metadata["homepage_uri"] = spec.homepage
17+
spec.metadata["source_code_uri"] = spec.homepage
18+
19+
#spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
20+
21+
# Specify which files should be added to the gem when it is released.
22+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
23+
spec.files = Dir.chdir(__dir__) do
24+
`git ls-files -z`.split("\x0").reject do |f|
25+
(File.expand_path(f) == __FILE__) ||
26+
f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
27+
end
28+
end
29+
spec.bindir = "exe"
30+
spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
31+
spec.require_paths = ["lib"]
32+
33+
spec.add_dependency "zeitwerk", '~> 2.6', '>= 2.6.8'
34+
spec.add_dependency "http", '~> 5.1', '>= 5.1.1'
35+
spec.add_dependency "thor", '~> 1.2', '>= 1.2.2'
36+
37+
# For more information and examples about making a new gem, check out our
38+
# guide at: https://bundler.io/guides/creating_gem.html
39+
spec.post_install_message = <<~POST_INSTALL
40+
_____ _ _____
41+
/ ____| | /\ |_ _|
42+
| | | | / \ | |
43+
| | | | / /\ \ | |
44+
| |____| |____ / ____ \ _| |_
45+
\_____|______/_/ \_\_____|
46+
47+
Thank you for using clai.
48+
49+
clai is early alpha software, beware of unexpected costs.
50+
Make sure to add a billing limit to your OpenAI api key.
51+
52+
To start using clai, run 'clai setup'
53+
POST_INSTALL
54+
end

‎docs/chat.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Chat
2+
3+
Send a single prompt to the completions api.
4+
5+
Some examples:
6+
7+
8+
```
9+
$ clai chat "Tell me a funny joke"
10+
```

‎docs/intro.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Introduction
2+
3+
You can think of `clai` as ChatGPT for the terminal.
4+
It's very basic at the moment. You can think of it as ChatGPT for the terminal. I'm currently trying to incorporate clai in my daily work, so I'm still experimenting with the API.
5+
6+
`clai` currently supports OpenAI and needs a paid API key to work.
7+
8+
My main use case currently is to have a terminal opened with a clai session and ask questions instead of googling.
9+
10+
0.x.0 will be unstable and untested, I'm currently aiming to release a tested 1.0.0 soon. Please see [here](https://github.com/codergeek121/clai/CONTRIBUTING.MD) on how to contribute at this stage of the project.

‎docs/personas.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Personas
2+
3+
TODO: This feature is still under development!
4+
5+
A clai setup should allow preconfiguring multiple personas. Each command should support a `--persona` option to allow setting some default prompts to the api.
6+
7+
An example could look like this:
8+
9+
```yaml
10+
personas:
11+
work:
12+
- Use professional language
13+
- Keep your answer below 100 words
14+
bavarian:
15+
- Use a bavarian accent
16+
17+
# Starting a session with a preselected persona
18+
$ clai session --persona bavarian
19+
Your prompt: <Your prompt><Enter>
20+
Some bavarian answer.
21+
```
22+
23+
The default setup should have useful personas as a default.

‎docs/session.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Session
2+
3+
TODO

‎docs/setup.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Setup
2+
3+
TODO

‎exe/clai

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#!/usr/bin/env ruby
2+
# frozen_string_literal: true
3+
4+
require "bundler/setup"
5+
require "clai"
6+
7+
CLAI::CLI.start(ARGV)

‎lib/clai.rb

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# frozen_string_literal: true
2+
3+
require "thor"
4+
require "http"
5+
require "zeitwerk"
6+
require "debug"
7+
require "fileutils"
8+
require "yaml"
9+
10+
loader = Zeitwerk::Loader.for_gem
11+
loader.inflector.inflect(
12+
"clai" => "CLAI",
13+
"http_client" => "HTTPClient",
14+
"cli" => "CLI",
15+
)
16+
loader.setup
17+
18+
module CLAI
19+
class Error < StandardError; end
20+
class APIKeyMissing < Error; end
21+
22+
@@config_file_path = File.expand_path("~/.config/clai/clai.yml")
23+
def self.config_file_path
24+
@@config_file_path
25+
end
26+
27+
@@strings = YAML.safe_load_file(File.expand_path("../strings/strings.yml", __FILE__))
28+
def self.strings
29+
@@strings
30+
end
31+
S = ->(name) { @@strings.fetch(name.to_s) { raise "Unknown translation! Please file a bug!" } }
32+
end
33+
34+
loader.eager_load

0 commit comments

Comments
 (0)