Skip to content

Commit 01c2ebc

Browse files
Merge remote-tracking branch 'origin/aug2023-prod-launch'
2 parents f988aea + fb5a3d8 commit 01c2ebc

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed

README.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,11 @@ run ```bito --help``` or ```bito config --help```
8787
##### On MAC/Linux:
8888

8989
- run ```bito -v``` or ```bito --version``` to print the version number of Bito CLI installed currently.
90+
9091
- run ```bito –p writedocprompt.txt -f mycode.js``` for non-interactive mode in Bito (where writedocprompt.txt will contain your prompt text such as "Explain the code below in brief" and mycode.js will contain the actual code on which the action is to be performed).
9192

93+
- run ```bito –p writedocprompt.txt``` to read the content at standard input in Bito (where writedocprompt.txt will contain your prompt text such as "Explain the code below in brief" and input provided will have the actual content on which the action is to be performed).
94+
9295
- run ```cat file.txt | bito``` to directly cat a file and pipe it to bito and get instant result for your query.
9396

9497
- run ```cat inventory.sql | bito -p testdataprompt.txt > testdata.sql``` to redirect your output directly to a file (where -p can be used along with cat to perform prompt related action on the given content).
@@ -99,7 +102,10 @@ run ```bito --help``` or ```bito config --help```
99102

100103
##### On Windows:
101104
- run ```bito -v``` or ```bito --version``` to print the version number of Bito CLI installed currently.
102-
- run ```bito – p writedocprompt.txt -f mycode.js``` for non-interactive mode in Bito (where writedocprompt.txt will contain your prompt text such as "Explain the code below in brief" and mycode.js will contain the actual code on which the action is to be performed).
105+
106+
- run ```bito –p writedocprompt.txt -f mycode.js``` for non-interactive mode in Bito (where writedocprompt.txt will contain your prompt text such as "Explain the code below in brief" and mycode.js will contain the actual code on which the action is to be performed).
107+
108+
- run ```bito –p writedocprompt.txt``` to read the content at standard input in Bito (where writedocprompt.txt will contain your prompt text such as "Explain the code below in brief" and input provided will have the actual content on which the action is to be performed).
103109

104110
- run ```type file.txt | bito``` to take input from file in windows and pipe it to bito and get instant result for your query.
105111

@@ -133,6 +139,43 @@ Here are two examples for you to see My Prompt in action:
133139

134140
[![Video](https://markdown-videos.vercel.app/youtube/GYa0p511NUQ)](https://www.youtube.com/watch?v=GYa0p511NUQ)
135141

142+
### Bito CLI Configuration
143+
#### bito config [flags]
144+
145+
- run ```bito config -l``` or ```bito config --list``` to list all config variables and values.
146+
147+
- run ```bito config -e``` or ```bito config --edit``` to open the config file in default editor.
148+
149+
#### Sample Configuration
150+
151+
bito:<br/>
152+
&emsp;access_key: ""<br/>
153+
&emsp;email: first.last@mycompany.com<br/>
154+
&emsp;preferred_ai_model: ADVANCED<br/>
155+
settings:<br/>
156+
&emsp;auto_update: true<br/>
157+
&emsp;max_context_entries: 20<br/>
158+
159+
##### Preferred AI Model Type
160+
By default AI Model Type is set to ```ADVANCED``` and it can be overridden by running ```bito -m <BASIC/ADVANCED>```
161+
Model type is used for AI query in the current session. Model type can be set to BASIC/ADVANCED, which is case insensitive.
162+
163+
##### Access Key
164+
Access Key can be created at Bito Web UI and used in Bito CLI.
165+
166+
To create an access key, do the following:
167+
- Login into your account at: https://alpha.bito.ai
168+
- Once logged in open: https://alpha.bito.ai/home/settings/advanced
169+
- Click on the "Create new key" button under section "Bito Access Key" to create a new key and copy it.
170+
- Make sure to protect your key and do not check it in, into any code to avoid accidental leakage.
171+
- In case you think your key is compromised, you can delete the existing key and create new key anytime.
172+
173+
Access Key is an alternate authentication mechanism to Email & OTP based aunthentication.
174+
175+
176+
Access Key can be persisted in Bito CLI by running ```bito config -e```
177+
Such persisted Access Key can be over-ridden by running ```bito -k <access-key>``` or ```bito --key <access-key>``` for the transient session.
178+
136179
## FAQs
137180

138181
### Enabling unicode For Windows 10 and below:

0 commit comments

Comments
 (0)