-
Notifications
You must be signed in to change notification settings - Fork 175
/
update_help.js
131 lines (92 loc) · 4.13 KB
/
update_help.js
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
const cp = require("child_process")
const { writeFileSync } = require("fs")
const helpTxt = cp.execSync("go run *.go -h").toString().trim()
const readmeTxt = `<p align="center"><img src="tgpt.svg"></p>
# Terminal GPT (tgpt) 🚀
[](https://github.com/aandrew-me/tgpt)
[](https://github.com/aandrew-me/tgpt/releases/latest)
tgpt is a cross-platform command-line interface (CLI) tool that allows you to use AI chatbot in your Terminal without requiring API keys.
### Currently available providers:
- [Blackbox AI](https://www.blackbox.ai/) (Blackbox model)
- [Duckduckgo](https://duckduckgo.com/aichat) (Supports several models)
- [Groq](https://groq.com/) (Requires a free API Key. LLaMA2-70b & Mixtral-8x7b)
- [KoboldAI](https://koboldai-koboldcpp-tiefighter.hf.space/) (koboldcpp/HF_SPACE_Tiefighter-13B)
- [Ollama](https://www.ollama.com/) (Supports many models)
- [OpenAI](https://platform.openai.com/docs/guides/text-generation/chat-completions-api) (All models, Requires API Key, supports custom endpoints)
- [Phind](https://www.phind.com/agent) (Phind Model)
**Image Generation Model**: Craiyon V3
## Usage
\`\`\`
${helpTxt}
\`\`\`
## Installation ⏬
### Download for GNU/Linux 🐧 or MacOS 🍎
The default download location is \`/usr/local/bin\`, but you can change it in the command to use a different location. However, make sure the location is added to your PATH environment variable for easy accessibility.
You can download it with the following command:
\`\`\`bash
curl -sSL https://raw.githubusercontent.com/aandrew-me/tgpt/main/install | bash -s /usr/local/bin
\`\`\`
If you are using Arch Linux, you can install with pacman:
\`\`\`bash
pacman -S tgpt
\`\`\`
### FreeBSD 😈
To install the [port](https://www.freshports.org/www/tgpt):
\`\`\`
cd /usr/ports/www/tgpt/ && make install clean
\`\`\`
To install the package, run one of these commands:
\`\`\`
pkg install www/tgpt
pkg install tgpt
\`\`\`
### Install with Go
You need to [add the Go install directory to your system's shell path](https://go.dev/doc/tutorial/compile-install).
\`\`\`bash
go install github.com/aandrew-me/tgpt/v2@latest
\`\`\`
### Windows 🪟
- **Scoop:** Package installation with [Scoop](https://scoop.sh/) can be done using the following command:
\`\`\`bash
scoop install https://raw.githubusercontent.com/aandrew-me/tgpt/main/tgpt.json
\`\`\`
## Updating ⬆️
If you installed the program with the installation script, you may update it with
\`\`\`bash
tgpt -u
\`\`\`
**It may require admin privileges.**
### Proxy
Support:
1. environment variable
http_proxy or HTTP_PROXY with following available formats:
- Http Proxy [ \`http://ip:port\` ]
- Http Auth [ \`http://user:pass@ip:port\` ]
- Socks5 Proxy [ \`socks5://ip:port ]\`
- Socks5 Auth [ \`socks5://user:pass@ip:port\` ]
2. configuration file
file location in the following order:
- ./proxy.txt (in the same directory from where you are executing)
- ~/.config/tgpt/proxy.txt
Example:
\`\`\`bash
http://127.0.0.1:8080
\`\`\`
### From Release
You can download the executable for your operating system, rename it to \`tgpt\` (or any other desired name), and then execute it by typing \`./tgpt\` while in that directory. Alternatively, you can add it to your PATH environmental variable and then execute it by simply typing \`tgpt\`.
## Uninstalling
If you installed with the install script, you can execute the following command to remove the tgpt executable
\`\`\`
sudo rm $(which tgpt)
\`\`\`
Configuration file is usually located in \`~/.config/tgpt\` on GNU/Linux Systems and in \`"Library/Application Support/tgpt"\` on MacOS
`
try {
writeFileSync("./README.md", readmeTxt);
console.log("Updated README")
} catch (error) {
console.log("Failed to update README", error)
}