@fettstorch/clai 0.1.0 → 0.1.2

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.
Files changed (2) hide show
  1. package/README.md +7 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -35,6 +35,8 @@ clai
35
35
  ```
36
36
  <img width="300" src="https://github.com/user-attachments/assets/f4a81e24-ef5b-42b7-bca7-188763d4e5cf" />
37
37
 
38
+ The clie expects either a URL or a search query or no argument at all.
39
+ When passing a search query without quotes make sure not to use any special characters, that might confuse the CLI e.g. ?
38
40
 
39
41
  ### Programmatic API
40
42
  ```ts
@@ -43,6 +45,11 @@ import clai from 'clai';
43
45
  const { summary, links, sources } = await clai('https://example.com', 'your-openai-api-key');
44
46
  ```
45
47
 
48
+ ## Issues
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
+ - 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)
52
+
46
53
  ## License
47
54
 
48
55
  ISC
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fettstorch/clai",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "main": "dist/index.js",
5
5
  "bin": {
6
6
  "clai": "dist/cli.js"