Obsidian AutoGPT Plugin

Auto-GPT-Obsidian

Empower Auto-GPT with one's Obsidian Vault and Vise Versa!

Table of Contents

1. Features
2. Getting Started
3. Use Cases
4. Commands
5. Contribution
6. Acknowledgments

Introduction

This plugin for Auto-GPT allows for robust interactions with Obsidian Markdown Elements/Sytax. Also, this plugin provides toolings for Auto-GPT Agents to create flashcards and featured notes programmatically. Additionally, povides various interfaces of the corresponding data elements from notes.

While Obsidian has a multitude of plugin which change it's behavior within the context of markdown notes.

Features

Enable AutoGPT with guided generate ai to create automatically flashcards for studying. (similar to the arcana plugin, but automatically generated from your notes).

Automate the filling out of boing but potentially impotant metadata in notes in the vault.

Enable AutoGPT with commands to find and integrate unlinked or lost notes from your Obsidian Vault

Enable AutoGPT with commands to house attached media files into a Folder Note similar to Consistent Names

Provides various features that coinside with Obsidian Vault makdown standards and features

Expand on or leave footnotes in you notes progrrammatically as autogpt or as commands from autogpt to futher discover an topic.

Create notes in Obsidian with Auto-GPT automatically

Create flashcards in Obsidian with Auto-GPT automatically with the Spaced Repetition Plugin for Obsidian MD.

Use an (soon to be) Community Accepted Plugins for aiding in the syncing of your vault to this plugin, git-gpt-sync.

Create notes in styled/templated markdown with Auto-GPT commands that feature guided generative ai programs.

Prerequisites

1. Install Auto-GPT, checkout the latest release v0.3.0 which adds plugin support, and make sure you can run it successfully.
2. Install extra dependencies for this plugin.

pip install obsidiantools python-dotenv auto_gpt_plugin_template

Getting Started

To download it directly from your Auto-GPT directory (Once finished and accepted), you can run this command on Linux or MacOS:

curl -L -o ./plugins/Auto-GPT-Obsidian.zip https://github.com/conneroisu/Auto-GPT-Obsidian/archive/refs/heads/master.zip

In PowerShell:

Invoke-WebRequest -Uri "https://github.com/conneroisu/Auto-GPT-Obsidian/archive/refs/heads/master.zip"     -OutFile "./plugins/Auto-GPT-Obsidian.zip"

Github Source Code Install

Either navigate to https://github.com/conneroisu/Auto-GPT-Obsidian/archive/refs/heads/master.zip or use the link below, and download the source code. Place the ZIP file under the Auto-GPT/plugins/ directory inside of your working directory of Auto-GPT. More specifically, place the zip files into the directoy containing __PUT_PLUGIN_ZIPS_HERE__.

Click Here to download the source code as ZIP, and place the ZIP file under Auto-GPT/plugins/.

Edit Environment

Auto-GPT/.env

1. Add this plugin to the ALLOWLISTED_PLUGINS variable in the .env file for Auto-GPT. More specifically, append AutoGPTObsidian to ALLOWLISTED_PLUGINS in the .env file.

ALLOWLISTED_PLUGINS=AutoGPTObsidian

2. Add the path to your Obsidian vault create a public or private github repository for your vault variable in the .env file for Auto-GPT. More specifically, append the path to your Obsidian vault to OBSIDIAN_VAULT_PATH in the .env file.

################################################################################
### Obsidian
################################################################################

## OBSIDIAN_VAULT_NAME - the name of the obsidian vault
## OBSIDIAN_VAULT_GIT_URL - the repository url (without .git) of the vault.
## OBSIDIAN_FLASHCARD_SUBDIRECTORY - the subdirectory in which to create flashcards with spaced repition format/syntax.
## OBSIDIAN_GITHUB_API_KEY - the API KEY to which responsibilities inside of the github repository ahave been allowed
## OBSIDIAN_GITHUB_USERNAME - the username of the account housing the github repository and key.

OBSIDIAN_VAULT_NAME=Auto-GPT-Obsidian-Example-Vault
OBSIDIAN_VAULT_GIT_URL=https://github.com/conneroisu/Auto-GPT-Obsidian-Example-Vault
OBSIDIAN_FLASHCARD_SUBDIRECTORY=/internal/vault/path/
OBSIDIAN_GITHUB_API_KEY=<github_api_key/token>
OBSIDIAN_GITHUB_USERNAME=<github_username>

Run Auto-GPT and enjoy integrations of Auto-GPT with Obsidian!

FAQ

If you encounter problems or have any ideas, feel free to open an issue or pull request.

• Issues
• Pull Requests

(back to top)

Contribution

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

(back to top)

Run Tests

pytest -vs

Contributors will be featured here with a link to their GitHub profile with accompanying social image.

Conner Ohnesorge

(back to top)

Commands (Working)

All of the commands below are operational as plugin commands meaning that an AutoGPT instance can call them when both AutoGPT and Obsidian plugin are installed correctly. The commands below are the commands that are currently implemented. More commands will be added in the future. If you have a suggestion for a command, please open an issue with the tag "enhancement". Additionally, if you have an issue with a command, please open an issue with the tag "bug".

create_note(title, aliases, tags, summary, content)

This command creates a note inside the vault with a title, content, tags, and a summary.

(back to top)

Acknowledgements

• Auto-GPT - The main project that this plugin is for
• Microsoft Guidance - Microsoft Python llm inferencing markup library.
• Arcana Plugin for Obsidian - Inspiation to make flashcard system.

(back to top)