File size: 7,360 Bytes
886d8e9
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
---
title: Arguments
---

**[Modes](/docs/usage/terminal/arguments#modes)**

`--vision`, `--os`.

**[Model Settings](/docs/usage/terminal/arguments#model-settings)**

`--model`, `--fast`, `--local`, `--temperature`, `--context_window`, `--max_tokens`, `--max_output`, `--api_base`, `--api_key`, `--api_version`, `--llm_supports_functions`, `--llm_supports_vision`.

**[Configuration](/docs/usage/terminal/arguments#Configuration)**

`--profiles`, `--profile`, `--custom_instructions`, `--system_message`.

**[Options](/docs/usage/terminal/arguments#options)**

`--safe_mode`, `--auto_run`, `--force_task_completion`, `--verbose`, `--max_budget`, `--speak_messages`, `--multi_line`.

**[Other](/docs/usage/terminal/arguments#other)**

`--version`, `--help`.

---

## Modes

#### `--vision` or `-vi`

Enables vision mode for multimodal models. Defaults to GPT-4-turbo.

<CodeGroup>
```bash Terminal
interpreter --vision
```

```yaml Config
vision: true
```

</CodeGroup>

#### `--os` or `-o`

Enables OS mode for multimodal models. Defaults to GPT-4-turbo.

<CodeGroup>
    
    ```bash Terminal
    interpreter --os
    ```

    ```yaml Config
    os: true
    ```

</CodeGroup>

---

## Model Settings

#### `--model` or `-m`

Specifies which language model to use. Check out the [models](https://docs.openinterpreter.com/language-model-setup/introduction) section for a list of available models.

<CodeGroup>
    
```bash Terminal
interpreter --model "gpt-3.5-turbo"
```

```yaml Config
model: gpt-3.5-turbo
```

</CodeGroup>

#### `--fast` or `-f`

Sets the model to gpt-3.5-turbo.

<CodeGroup>
```bash Terminal
interpreter --fast
```

```yaml Config
fast: true
```

</CodeGroup>

#### `--local` or `-l`

Run the model locally. Check the [models page](/language-model-setup/introduction) for more information.

<CodeGroup>

```bash Terminal
interpreter --local
```

```yaml Config
local: true
```

</CodeGroup>

#### `--temperature` or `-t`

Sets the randomness level of the model's output.

<CodeGroup>
    
```bash Terminal
interpreter --temperature 0.7
```

```yaml Config
temperature: 0.7
```

</CodeGroup>

#### `--context_window` or `-c`

Manually set the context window size in tokens for the model.

<CodeGroup>

```bash Terminal
interpreter --context_window 16000
```

```yaml Config
context_window: 16000
```

</CodeGroup>

#### `--max_tokens` or `-x`

Sets the maximum number of tokens that the model can generate in a single response.

<CodeGroup>

```bash Terminal
interpreter --max_tokens 100
```

```yaml Config
max_tokens: 100
```

</CodeGroup>

#### `--max_output` or `-xo`

Set the maximum number of characters for code outputs.

<CodeGroup>
```bash Terminal
interpreter --max_output 1000
```

```yaml Config
max_output: 1000
```

</CodeGroup>
#### `--api_base` or `-ab`

If you are using a custom API, specify its base URL with this argument.

<CodeGroup>

```bash Terminal
interpreter --api_base "https://api.example.com"
```

```yaml Config
api_base: https://api.example.com
```

</CodeGroup>

#### `--api_key` or `-ak`

Set your API key for authentication when making API calls.

<CodeGroup>

```bash Terminal
interpreter --api_key "your_api_key_here"
```

```yaml Config
api_key: your_api_key_here
```

</CodeGroup>

#### `--api_version` or `-av`

Optionally set the API version to use with your selected model. (This will override environment variables)

<CodeGroup>
```bash Terminal
interpreter --api_version 2.0.2
```

```yaml Config
api_version: 2.0.2
```

</CodeGroup>
#### `--llm_supports_functions` or `-lsf`

Inform Open Interpreter that the language model you're using supports function calling.

<CodeGroup>
```bash Terminal
interpreter --llm_supports_functions
```

```yaml Config
llm_supports_functions: true
```

</CodeGroup>
#### `--no-llm_supports_functions`

Inform Open Interpreter that the language model you're using does not support function calling.

<CodeGroup>
  ```bash Terminal interpreter --no-llm_supports_functions ```
</CodeGroup>

#### `--llm_supports_vision` or `-lsv`

Inform Open Interpreter that the language model you're using supports vision.

<CodeGroup>
```bash Terminal
interpreter --llm_supports_vision
```

```yaml Config
llm_supports_vision: true
```

</CodeGroup>

---

## Configuration

#### `--profiles`

Opens the directory containing all profiles. They can be edited in your default editor.

<CodeGroup>
```bash Terminal
interpreter --profilees
```

</CodeGroup>

#### `--profile` or `-p`

Optionally set a profile to use.

<CodeGroup>
```bash Terminal
interpreter --profile "default.yaml"
```

</CodeGroup>

#### `--custom_instructions` or `-ci`

Appends custom instructions to the system message. This is useful for adding information about the your system, preferred languages, etc.

<CodeGroup>
```bash Terminal
interpreter --custom_instructions "This is a custom instruction."
```

```yaml Config
custom_instructions: "This is a custom instruction."
```

</CodeGroup>

#### `--system_message` or `-s`

We don't recommend modifying the system message, as doing so opts you out of future updates to the system message. Use `--custom_instructions` instead, to add relevant information to the system message. If you must modify the system message, you can do so by using this argument, or by opening the profile using `--profiles`.

<CodeGroup>
```bash Terminal
interpreter --system_message "You are Open Interpreter..."
```

```yaml Config
system_message: "You are Open Interpreter..."
```

## Options

#### `--safe_mode`

Enable or disable experimental safety mechanisms like code scanning. Valid options are `off`, `ask`, and `auto`.

<CodeGroup>

```bash Terminal
interpreter --safe_mode ask
```

```yaml Config
safe_mode: ask
```

</CodeGroup>

#### `--auto_run` or `-y`

Automatically run the interpreter without requiring user confirmation.

<CodeGroup>

```bash Terminal
interpreter --auto_run
```

```yaml Config
auto_run: true
```

</CodeGroup>

#### `--force_task_completion` or `-fc`

Runs Open Interpreter in a loop, requiring it to admit to completing or failing every task.

<CodeGroup>
```bash Terminal
interpreter --force_task_completion
```

```yaml Config
force_task_completion: true
```

</CodeGroup>

#### `--verbose` or `-v`

Run the interpreter in verbose mode. Debug information will be printed at each step to help diagnose issues.

<CodeGroup>

```bash Terminal
interpreter --verbose
```

```yaml Config
verbose: true
```

</CodeGroup>

#### `--max_budget` or `-b`

Sets the maximum budget limit for the session in USD.

<CodeGroup>

```bash Terminal
interpreter --max_budget 0.01
```

```yaml Config
max_budget: 0.01
```

</CodeGroup>

#### `--speak_messages` or `-sm`

(Mac Only) Speak messages out loud using the system's text-to-speech engine.

<CodeGroup>
```bash Terminal
interpreter --speak_messages
```

```yaml Config
speak_messages: true
```

</CodeGroup>

#### `--multi_line` or `-ml`

Enable multi-line inputs starting and ending with ` ``` `

<CodeGroup>
```bash Terminal
interpreter --multi_line
```

```yaml Config
multi_line: true
```

</CodeGroup>

---

## Other

#### `--version`

Get the current installed version number of Open Interpreter.

<CodeGroup>```bash Terminal interpreter --version ```</CodeGroup>

#### `--help` or `-h`

Display all available terminal arguments.

<CodeGroup>
```bash Terminal
interpreter --help
```

</CodeGroup>