https://github.com/mikebirdtech/obsidian-open-interpreter

The power of Open Interpreter in your Obsidian vault
https://github.com/mikebirdtech/obsidian-open-interpreter

obsidian obsidian-plugin open-interpreter

Last synced: about 2 months ago
JSON representation

The power of Open Interpreter in your Obsidian vault

• Host: GitHub
• URL: https://github.com/mikebirdtech/obsidian-open-interpreter
• Owner: MikeBirdTech
• License: mit
• Created: 2024-08-16T15:11:33.000Z (4 months ago)
• Default Branch: master
• Last Pushed: 2024-10-24T20:10:24.000Z (2 months ago)
• Last Synced: 2024-10-25T12:56:48.504Z (2 months ago)
• Topics: obsidian, obsidian-plugin, open-interpreter
• Language: TypeScript
• Homepage:
• Size: 69.3 KB
• Stars: 16
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Open Interpreter Plugin for Obsidian

This plugin integrates Open Interpreter with Obsidian, allowing you to run AI-powered automations directly within your vault using natural language commands.

## Features

- Use natural language commands to automate tasks within your Obsidian vault

- Interactive chat interface for communicating with Open Interpreter

- Automatic installation check and guidance for Open Interpreter

- Seamless integration with your Obsidian vault, with full access to read, write, and edit Markdown files

- Always requires user approval before executing actions

## Installation

1. Install the plugin from the [Obsidian Community Plugins browser](obsidian://show-plugin?id=open-interpreter)

2. Enable the plugin in Obsidian Community plugins settings.

3. Ensure [Open Interpreter](https://github.com/OpenInterpreter/open-interpreter) is installed on your system. If not, the plugin will guide you through the installation process.

## Usage

1. Use the command palette (Cmd/Ctrl + P) and search for "AI Command".

2. Enter your natural language command in the input modal that appears.

3. Interact with the interpreter through the chat interface to automate tasks within your vault.

## Requirements

- Obsidian v0.15.0 or higher

- Open Interpreter installed on your system

## Configuration

The plugin automatically detects your Obsidian vault path and sets up the necessary environment for Open Interpreter to run within your vault context.

You will need to set your API key(s) and appropriate settings for your selected model in Settings.

## Troubleshooting

If you encounter issues:

1. Ensure Open Interpreter is correctly installed and accessible from your terminal.

2. Check the console for any error messages.

3. Verify that your GROQ_API_KEY, OPENAI_API_KEY, and/or ANTHROPIC_API_KEY is set correctly.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request ❤️

## License

This project is licensed under the MIT License.