From d18b0f60b2516a935c547da8cf4f883bb46c1085 Mon Sep 17 00:00:00 2001 From: Ty Fiero Date: Wed, 3 Jan 2024 22:23:09 -0800 Subject: [PATCH] Add os docs --- docs/mint.json | 13 ++++--------- docs/usage/terminal/arguments.mdx | 13 +++---------- docs/usage/terminal/conversation-history.mdx | 9 --------- docs/usage/terminal/os.mdx | 17 +++++++++++++++++ 4 files changed, 24 insertions(+), 28 deletions(-) delete mode 100644 docs/usage/terminal/conversation-history.mdx create mode 100644 docs/usage/terminal/os.mdx diff --git a/docs/mint.json b/docs/mint.json index af670bb3fb..3cb313e8ff 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -31,10 +31,7 @@ "navigation": [ { "group": "Getting Started", - "pages": [ - "introduction", - "setup" - ] + "pages": ["introduction", "setup"] }, { "group": "Usage", @@ -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" ] }, { @@ -65,9 +62,7 @@ }, { "group": "Desktop", - "pages": [ - "usage/desktop/install" - ] + "pages": ["usage/desktop/install"] } ] }, diff --git a/docs/usage/terminal/arguments.mdx b/docs/usage/terminal/arguments.mdx index b2cb304da5..3eafe25edd 100644 --- a/docs/usage/terminal/arguments.mdx +++ b/docs/usage/terminal/arguments.mdx @@ -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`. --- @@ -416,17 +416,10 @@ speak_messages: true Get the current installed version number of Open Interpreter. -```bash Terminal interpreter --version ``` - -#### `--conversations` - -Display a list of previous conversations. - ```bash Terminal -interpreter --conversations +interpreter --version ``` - #### `--help` or `-h` diff --git a/docs/usage/terminal/conversation-history.mdx b/docs/usage/terminal/conversation-history.mdx deleted file mode 100644 index a918742684..0000000000 --- a/docs/usage/terminal/conversation-history.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Conversation History ---- - -You can resume chats via `interpreter --conversations`. - -```shell -interpreter --conversations -``` \ No newline at end of file diff --git a/docs/usage/terminal/os.mdx b/docs/usage/terminal/os.mdx new file mode 100644 index 0000000000..4054820dad --- /dev/null +++ b/docs/usage/terminal/os.mdx @@ -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.