@fettstorch/clai 0.1.1 → 0.1.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 +3 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Command Line AI Interface (CLAI)
|
|
2
2
|
|
|
3
3
|
A tool for AI powered web search/scrape and summarization in the Terminal.
|
|
4
|
-
Built for fun
|
|
4
|
+
Built for fun in order to learn more about AI and CLIs.
|
|
5
5
|
|
|
6
6
|
## Installation
|
|
7
7
|
|
|
@@ -13,7 +13,7 @@ Install it locally in order to use the clai function in your project.
|
|
|
13
13
|
```bash
|
|
14
14
|
npm install clai
|
|
15
15
|
```
|
|
16
|
-
Using both the CLI tool and the clai function requires an OpenAI API key.
|
|
16
|
+
Using both the CLI tool and the clai function requires an OpenAI API key. For the CLI tool make sure to set the `OPENAI_API_KEY` environment variable.
|
|
17
17
|
|
|
18
18
|
## OpenAI API Key Setup
|
|
19
19
|
|
|
@@ -48,6 +48,7 @@ const { summary, links, sources } = await clai('https://example.com', 'your-open
|
|
|
48
48
|
## Issues
|
|
49
49
|
- Needs a better prompt in order to more reliably stop narrating a page's content and rather cite it in a more concise manner.
|
|
50
50
|
- The first answer's stream animation appears to sometimes not be skippable using 'enter'
|
|
51
|
+
- large sites might surpass the token limit (currently not handled gracefully)
|
|
51
52
|
|
|
52
53
|
## License
|
|
53
54
|
|