-
Notifications
You must be signed in to change notification settings - Fork 758
Add foam-notes agent skill recipe #1585
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Foam Notes Agent Skill | ||
|
|
||
| This #recipe describes how to use [foam-notes](https://github.com/Hegghammer/foam-notes), an [AgentSkills](https://agentskills.io/specification)-compatible skill that lets AI coding assistants work with your Foam notes. | ||
|
|
||
| ## Supported Assistants | ||
|
|
||
| - [Claude Code](https://claude.com/product/claude-code) | ||
| - [Codex](https://openai.com/codex/) | ||
| - [OpenCode](https://opencode.ai) | ||
| - Any other assistant that supports the AgentSkills format | ||
|
|
||
| ## Features | ||
|
|
||
| - Create, edit, delete, and rename notes | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. it's too bad that you can't leverage any of the Foam code for those python scripts. Basically you are replicating some of Foam's features, whereas if you were to use |
||
| - Intelligent wikilink and tag suggestions | ||
| - Backlinks discovery | ||
| - Daily notes and templates | ||
| - Graph visualization | ||
| - Full Foam documentation included for easy querying | ||
|
|
||
| ## Installation | ||
|
|
||
| Clone the skill repository into your assistant's skill folder: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/Hegghammer/foam-notes.git | ||
| ``` | ||
|
|
||
| The location of the skill folder depends on your assistant: | ||
|
|
||
| - **Claude Code**: `.claude/skills/` | ||
| - **OpenCode**: `.opencode/skills/` | ||
| - **Codex**: `.codex/skills/` | ||
|
|
||
| Refer to your assistant's documentation for details. | ||
|
|
||
| ## Usage | ||
|
|
||
| Once installed, the skill is automatically available to your assistant. You can ask it to create new notes, edit existing ones, suggest wikilinks and tags, find backlinks, and more. If you find that the skill doesn't do quite what you want, just have the agent modify the skill for you. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please put a warning here about prompt injection and the security implications of using 3rd party skills?
Users should review the skill files/scripts before adopting them