Skip to content

Latest commit

 

History

History
67 lines (44 loc) · 2.82 KB

README_en.md

File metadata and controls

67 lines (44 loc) · 2.82 KB

English | 中文

Introduction

Tars is an Obsidian plugin that supports text generation based on tag suggestions, using services like Claude, OpenAI, Kimi, Doubao, Qwen, Zhipu, DeepSeek, QianFan & more. The name Tars comes from the robot Tars in the movie "Interstellar".

Features

  • Text generation AI assistant triggered by tags

Text generation triggered by tag

  • Support for internal links

Internal link support

AI providers

If the AI provider you want is not in the list above, you can propose a specific plan in the issue.

How to use

Add an AI assistant in the settings page, set the API key, and then use the corresponding tag in the editor to trigger the AI assistant. Trigger through a conversation form, with user messages first, then trigger the AI assistant to answer questions.

#User : 1+1=?(user message)
(blank line)
#Claude :(trigger)

If you are not satisfied with the AI assistant's answer and want to retry. Use the plugin command "Select the message at the cursor", select and delete the AI assistant's response content, modify your question, and trigger the AI assistant again.

If the model type you want is not in the AI assistant in the settings page, or the server address needs to be customized, you can configure it in the "Override input parameters" in the settings, input JSON format, for example {"model":"your model", "baseURL": "your url"}.

Conversations syntax

A paragraph cannot contain multiple messages. Messages should be separated by blank lines.

Conversations syntax

  • The conversation messages will send to the configured AI assistant.
  • Callout sections will be ignored. You can write content in the callout without sending it to the AI assistant. Callout is not markdown syntax, it is an obsidian extension syntax.
  • Start a new conversation with new conversation tag.

Recommended

For better appearance, it is recommended to use the colored tags plugin.

Colored tags plugin