Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add os docs #868

Merged
merged 1 commit into from
Jan 4, 2024
Merged

Add os docs #868

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions docs/mint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,7 @@
"navigation": [
{
"group": "Getting Started",
"pages": [
"introduction",
"setup"
]
"pages": ["introduction", "setup"]
},
{
"group": "Usage",
Expand All @@ -45,10 +42,10 @@
"pages": [
"usage/terminal/arguments",
"usage/terminal/settings",
"usage/terminal/conversation-history",
"usage/terminal/magic-commands",
"usage/terminal/budget-manager",
"usage/terminal/vision"
"usage/terminal/vision",
"usage/terminal/os"
]
},
{
Expand All @@ -65,9 +62,7 @@
},
{
"group": "Desktop",
"pages": [
"usage/desktop/install"
]
"pages": ["usage/desktop/install"]
}
]
},
Expand Down
13 changes: 3 additions & 10 deletions docs/usage/terminal/arguments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ title: Arguments

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

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

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

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

---

Expand Down Expand Up @@ -416,17 +416,10 @@ speak_messages: true

Get the current installed version number of Open Interpreter.

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

#### `--conversations`

Display a list of previous conversations.

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

</CodeGroup>

#### `--help` or `-h`
Expand Down
9 changes: 0 additions & 9 deletions docs/usage/terminal/conversation-history.mdx
View file
Open in desktop

This file was deleted.

17 changes: 17 additions & 0 deletions docs/usage/terminal/os.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: OS Mode
---

OS mode is a highly experimental mode that allows Open Interpreter to control the operating system visually through the mouse and keyboard. It provides a multimodal LLM like GPT-4V with the necessary tools to capture screenshots of the display and interact with on-screen elements such as text and icons. It will try to use the most direct method to achieve the goal, like using spotlight on Mac to open applications, and using query parameters in the URL to open websites with additional information.

OS mode is a work in progress, if you have any suggestions or experience issues, please reach out on our [Discord](https://discord.com/invite/6p3fD6rBVm).

To enable OS Mode, run the interpreter with the `--os` flag:

```bash
interpreter --os
```

Please note that screen recording permissions must be enabled for your terminal application for OS mode to work properly to work.

OS mode does not currently support multiple displays.
Loading