Skip to content

jcollingj/caret

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Caret Obsidian Plugin

Caret is an Obsidian plugin that brings the power of LLMs into your Obsidian Vault. Caret follows all the main Obsidian philosophies. It's local-first, privacy preserving and stores all generated data as local files.

Features:

  • AI Canvas: Use LLMs in the Obsidian Canvas for non-linear chat and more.
  • Chat: Chat directly in Obsidian. Reference other files in your vault. All chat logs are stored as vault files.
  • Use Any LLMs: Use Caret OP with local or remote LLMs. Caret OP has built in support for Ollama, OpenAI, Anthropic, Groq, OpenRouter and you can add any additional models yourself.

Discord

Come hang in the Discord! Everyone's welcome! Targeted for people using Obsidian, LLMs and AI tools.

https://discord.gg/8FyGfcH24N

The discord is for people to:

  • Hang
  • Ask questions
  • Talk shop
  • Show what they're working on
  • Discuss development of Caret OP

Good vibes only. Strongly enforced.

Note

Please note this is a general discord for Firstloop, who maintains the Caret plugin.

Docs

The full docs for the plugin will be on the site: https://www.caretplugin.ai/

Design Principles

These are the principles that guide the design and development of Caret. If a potential feature doesn't follow these then it probably won't be included in Caret OP.

  • Keep to local-first
  • No external services outside of LLM providers. No external APIs, DBs, RAG providers etc. All Caret OP functionality should come from just Caret OP.
  • All Caret OP data is should be stored as markdown files within the users vault. Anything that Caret creates or consumes should be savable as a local file.

Contributing

PRs welcome! More guidelines to come on this. But essentially if it's good, readable code that fits the Caret OP design principles then I'll try my best to incorporate it.

Big emphasis on "follows Caret OP's design principles". Please don't start working on something that violates a design principle without running it past me first. I don't want you to possibly waste time if it's a feature that I won't be able to incorporate.

Supporting Caret Obsidian Plugin

Caret OP is free and open source and it always will be. Caret is maintain by the developers at Firstloop. If you get a lot of value out of the plugin, you can consider buying a support subscription:

Supporting Caret OP is completely unnecessary but greatly appreciated. Your support helps fund continued development of the plugin - the more supporters we have, the more developer time we can dedicate to improving Caret OP.

You can also support First Loop by checking out our website. We offer consulting and software development services in addition to the products we build. We'd love to chat if we could build something useful for you!

About

Caret, an Obsidian Plugin

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 6

Languages