loz 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -0
- package/bin/index.js +3 -0
- package/package.json +46 -0
package/README.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Loz
|
|
2
|
+
|
|
3
|
+
This is a simple command line chatbot project written in TypeScript using the official ChatGPT API
|
|
4
|
+
|
|
5
|
+
## Getting Started
|
|
6
|
+
|
|
7
|
+
To get started, first clone the repository:
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
$ git clone https://github.com/joone/loz.git
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Then install the required dependencies:
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
$ ./install.sh
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Next, configure your OpenAPI credentials. You will need to create a `.env` file in the root of the project and add the following variables:
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
OPENAI_API_KEY=YOUR_KEY
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
$ loz
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Once lvz is running, you can start a conversation by interacting with it. lvz will respond with a relevant message based on the input.
|
|
32
|
+
|
|
33
|
+
## Contributing
|
|
34
|
+
|
|
35
|
+
If you'd like to contribute to this project, feel free to submit a pull request.
|
package/bin/index.js
ADDED
package/package.json
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "loz",
|
|
3
|
+
"version": "0.0.3",
|
|
4
|
+
"description": "CLI for various knowledge services",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "https://github.com/joone/loz.git"
|
|
8
|
+
},
|
|
9
|
+
"main": "dist/index.js",
|
|
10
|
+
"scripts": {
|
|
11
|
+
"start": "node dist/index.js",
|
|
12
|
+
"build": "tsc",
|
|
13
|
+
"test": "mocha -r ts-node/register tests/**/test.ts",
|
|
14
|
+
"lint": "eslint 'src/**/*.{js,ts}'",
|
|
15
|
+
"style": "npx prettier --write ."
|
|
16
|
+
},
|
|
17
|
+
"author": "Joone Hur",
|
|
18
|
+
"license": "BSD3",
|
|
19
|
+
"devDependencies": {
|
|
20
|
+
"@types/chai": "^4.2.9",
|
|
21
|
+
"@types/express": "^4.17.2",
|
|
22
|
+
"@types/mocha": "^7.0.1",
|
|
23
|
+
"@types/node": "^13.7.4",
|
|
24
|
+
"@typescript-eslint/eslint-plugin": "^2.20.0",
|
|
25
|
+
"@typescript-eslint/parser": "^2.20.0",
|
|
26
|
+
"chai": "^4.2.0",
|
|
27
|
+
"eslint": "^6.8.0",
|
|
28
|
+
"mocha": "^10.2.0",
|
|
29
|
+
"prettier": "2.5.1",
|
|
30
|
+
"ts-node": "^8.6.2",
|
|
31
|
+
"typescript": "^3.8.2"
|
|
32
|
+
},
|
|
33
|
+
"dependencies": {
|
|
34
|
+
"@types/yargs": "^17.0.22",
|
|
35
|
+
"dotenv": "^16.0.3",
|
|
36
|
+
"express": "^4.17.3",
|
|
37
|
+
"openai": "^3.1.0",
|
|
38
|
+
"yargs": "^17.7.1"
|
|
39
|
+
},
|
|
40
|
+
"bin": {
|
|
41
|
+
"loz": "bin/index.js"
|
|
42
|
+
},
|
|
43
|
+
"files": [
|
|
44
|
+
"dist"
|
|
45
|
+
]
|
|
46
|
+
}
|