https://github.com/nguyenvanduocit/obsidian-ai-assistant

https://github.com/nguyenvanduocit/obsidian-ai-assistant

Last synced: 17 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/nguyenvanduocit/obsidian-ai-assistant
• Owner: nguyenvanduocit
• License: other
• Created: 2023-02-05T06:36:07.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-28T04:25:12.000Z (about 1 year ago)
• Last Synced: 2024-08-08T00:44:41.604Z (4 months ago)
• Language: TypeScript
• Size: 438 KB
• Stars: 21
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• project-awesome - nguyenvanduocit/obsidian-ai-assistant - (TypeScript)

README

        
[![IMAGE ALT TEXT HERE](https://i.ytimg.com/vi/6YktLCGpz5s/maxresdefault.jpg)](https://www.youtube.com/watch?v=6YktLCGpz5s)

# Obsidian AI Assistant

A plugin for Obsidian that uses OpenAI's API to assist users in their note-taking and writing process.

## Features

-   [x] File rename: Suggest a new name for the file based on its content.

-   [x] Text completion: Suggest text based on what the user has already written, making it easier to write and faster to complete thoughts.

-   [ ] Text correction: The plugin can identify and suggest corrections for spelling, grammar, and style errors in real-time, making it easier to produce error-free writing.

-   [ ] Question answering: Answer questions based on the text in the note, providing quick access to information without leaving Obsidian.

## Usage

### File rename

1. Right-click on a file in the file explorer and select "AI Rename".

2. The plugin will suggest a new name for the file based on its content.

[View demo](https://www.youtube.com/watch?v=0cWN_JhoZm4)

### Text completion

1. Type your text in the editor.

2. Use palette command `AI Complete` to get suggestions.

If your cursor is at the end of the paragraph, the plugin will suggest text to complete the paragraph. If your cursor is in the new line, the plugin will suggest text based on the whole document.

[View demo](https://youtu.be/E0b9k6GlyL4)

### Text summarization

1. Select the text you want to summarize.

2. Press right-click and select "AI Summarize".

[View demo](https://www.youtube.com/watch?v=qU3DSY7eXA8)

### Text explanation

1. Select the text you want to explain.

2. Press right-click and select "AI Explain".

[View demo](https://www.youtube.com/watch?v=qU3DSY7eXA8)

### Question answering

TBD

## Requirements

-   Obsidian v0.9.8 or later

-   An OpenAI API key

## Support

For support, please open an issue on the GitHub repository or contact us via email.

## Contributing

Contributions are welcome! Please see the contribution guidelines for more information.

## License

The plugin is released under the MIT License.