mirror of
https://github.com/danielmiessler/Fabric.git
synced 2026-01-10 23:08:06 -05:00
Compare commits
42 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
710df90361 | ||
|
|
f5d94bfde6 | ||
|
|
1629f36c59 | ||
|
|
b4b8b96260 | ||
|
|
b07054adea | ||
|
|
ff21c60661 | ||
|
|
dfc0efbb67 | ||
|
|
d79449be4a | ||
|
|
5c6b84e4ec | ||
|
|
0fcd4945fb | ||
|
|
c10ae1ddd2 | ||
|
|
9774692b67 | ||
|
|
e45f24c6fd | ||
|
|
fb416c26ea | ||
|
|
e858700976 | ||
|
|
525b89be71 | ||
|
|
e15280d25d | ||
|
|
7a26012457 | ||
|
|
a5929fcad6 | ||
|
|
ad561248fd | ||
|
|
edb4490c86 | ||
|
|
70c9746bcb | ||
|
|
ba774d26c6 | ||
|
|
2e2177e26b | ||
|
|
72ec02bfd4 | ||
|
|
79b23f3106 | ||
|
|
f5ac7fd92c | ||
|
|
61027f30a4 | ||
|
|
575f83954d | ||
|
|
978731f385 | ||
|
|
373c1d0858 | ||
|
|
ca55f2375d | ||
|
|
d8671ea03a | ||
|
|
c49f47ecab | ||
|
|
6fc75282e8 | ||
|
|
d17afc1fba | ||
|
|
da6f974887 | ||
|
|
db2ba46099 | ||
|
|
744ec0824b | ||
|
|
b31f094e9b | ||
|
|
43597e4168 | ||
|
|
160703210b |
34
README.md
34
README.md
@@ -211,7 +211,7 @@ yt() {
|
||||
}
|
||||
```
|
||||
|
||||
This also creates a `yt` alias that allows you to use `yt https://www.youtube.com/watch?v=4b0iet22VIk` to get your transcripts.
|
||||
This also creates a `yt` alias that allows you to use `yt https://www.youtube.com/watch?v=4b0iet22VIk` to get transcripts, comments, and metadata.
|
||||
|
||||
#### Save your files in markdown using aliases
|
||||
|
||||
@@ -323,6 +323,7 @@ Application Options:
|
||||
-y, --youtube= YouTube video "URL" to grab transcript, comments from it and send to chat
|
||||
--transcript Grab transcript from YouTube video and send to chat (it used per default).
|
||||
--comments Grab comments from YouTube video and send to chat
|
||||
--metadata Grab metadata from YouTube video and send to chat
|
||||
-g, --language= Specify the Language Code for the chat, e.g. -g=en -g=zh
|
||||
-u, --scrape_url= Scrape website URL to markdown using Jina AI
|
||||
-q, --scrape_question= Search question using Jina AI
|
||||
@@ -474,16 +475,18 @@ alias pbpaste='xclip -selection clipboard -o'
|
||||
## Web Interface
|
||||
|
||||
Fabric now includes a built-in web interface that provides a GUI alternative to the command-line interface and an out-of-the-box website for those who want to get started with web development or blogging.
|
||||
You can use this app as a GUI interface for Fabric, a ready to go blog-site, or a website template for your own projects.
|
||||
You can use this app as a GUI interface for Fabric, a ready to go blog-site, or a website template for your own projects.
|
||||
|
||||
The `web/src/lib/content` directory includes starter `.obsidian/` and `templates/` directories, allowing you to open up the `web/src/lib/content/` directory as an [Obsidian.md](https://obsidian.md) vault. You can place your posts in the posts directory when you're ready to publish.
|
||||
|
||||
The `web/src/lib/content` directory includes starter `.obsidian/` and `templates/` directories, allowing you to open up the `web/src/lib/content/` directory as an [Obsidian.md](https://obsidian.md) vault. You can place your posts in the posts directory when you're ready to publish.
|
||||
### Installing
|
||||
|
||||
The GUI can be installed by navigating to the `web` directory and using `npm install`, `pnpm install`, or your favorite package manager. Then simply run the development server to start the app.
|
||||
The GUI can be installed by navigating to the `web` directory and using `npm install`, `pnpm install`, or your favorite package manager. Then simply run the development server to start the app.
|
||||
|
||||
_You will need to run fabric in a separate terminal with the `fabric --serve` command._
|
||||
_You will need to run fabric in a separate terminal with the `fabric --serve` command._
|
||||
|
||||
**From the fabric project `web/` directory:**
|
||||
|
||||
```shell
|
||||
npm run dev
|
||||
|
||||
@@ -491,9 +494,28 @@ npm run dev
|
||||
|
||||
pnpm run dev
|
||||
|
||||
## or your equivalent
|
||||
## or your equivalent
|
||||
```
|
||||
|
||||
### Streamlit UI
|
||||
|
||||
To run the Streamlit user interface:
|
||||
|
||||
```bash
|
||||
# Install required dependencies
|
||||
pip install streamlit pandas matplotlib seaborn numpy python-dotenv
|
||||
|
||||
# Run the Streamlit app
|
||||
streamlit run streamlit.py
|
||||
```
|
||||
|
||||
The Streamlit UI provides a user-friendly interface for:
|
||||
|
||||
- Running and chaining patterns
|
||||
- Managing pattern outputs
|
||||
- Creating and editing patterns
|
||||
- Analyzing pattern results
|
||||
|
||||
## Meta
|
||||
|
||||
> [!NOTE]
|
||||
|
||||
36
cli/cli.go
36
cli/cli.go
@@ -1,13 +1,15 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"github.com/danielmiessler/fabric/plugins/tools/youtube"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"github.com/danielmiessler/fabric/plugins/tools/youtube"
|
||||
|
||||
"github.com/danielmiessler/fabric/common"
|
||||
"github.com/danielmiessler/fabric/core"
|
||||
"github.com/danielmiessler/fabric/plugins/ai"
|
||||
@@ -42,7 +44,10 @@ func Cli(version string) (err error) {
|
||||
}
|
||||
}
|
||||
|
||||
registry := core.NewPluginRegistry(fabricDb)
|
||||
var registry *core.PluginRegistry
|
||||
if registry, err = core.NewPluginRegistry(fabricDb); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// if the setup flag is set, run the setup function
|
||||
if currentFlags.Setup {
|
||||
@@ -136,6 +141,21 @@ func Cli(version string) (err error) {
|
||||
}
|
||||
}
|
||||
|
||||
if currentFlags.ListExtensions {
|
||||
err = registry.TemplateExtensions.ListExtensions()
|
||||
return
|
||||
}
|
||||
|
||||
if currentFlags.AddExtension != "" {
|
||||
err = registry.TemplateExtensions.RegisterExtension(currentFlags.AddExtension)
|
||||
return
|
||||
}
|
||||
|
||||
if currentFlags.RemoveExtension != "" {
|
||||
err = registry.TemplateExtensions.RemoveExtension(currentFlags.RemoveExtension)
|
||||
return
|
||||
}
|
||||
|
||||
// if the interactive flag is set, run the interactive function
|
||||
// if currentFlags.Interactive {
|
||||
// interactive.Interactive()
|
||||
@@ -267,7 +287,7 @@ func Cli(version string) (err error) {
|
||||
func processYoutubeVideo(
|
||||
flags *Flags, registry *core.PluginRegistry, videoId string) (message string, err error) {
|
||||
|
||||
if !flags.YouTubeComments || flags.YouTubeTranscript {
|
||||
if (!flags.YouTubeComments && !flags.YouTubeMetadata) || flags.YouTubeTranscript {
|
||||
var transcript string
|
||||
var language = "en"
|
||||
if flags.Language != "" || registry.Language.DefaultLanguage.Value != "" {
|
||||
@@ -293,6 +313,16 @@ func processYoutubeVideo(
|
||||
|
||||
message = AppendMessage(message, commentsString)
|
||||
}
|
||||
|
||||
if flags.YouTubeMetadata {
|
||||
var metadata *youtube.VideoMetadata
|
||||
if metadata, err = registry.YouTube.GrabMetadata(videoId); err != nil {
|
||||
return
|
||||
}
|
||||
metadataJson, _ := json.MarshalIndent(metadata, "", " ")
|
||||
message = AppendMessage(message, string(metadataJson))
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
@@ -47,8 +47,9 @@ type Flags struct {
|
||||
ChangeDefaultModel bool `short:"d" long:"changeDefaultModel" description:"Change default model"`
|
||||
YouTube string `short:"y" long:"youtube" description:"YouTube video or play list \"URL\" to grab transcript, comments from it and send to chat or print it put to the console and store it in the output file"`
|
||||
YouTubePlaylist bool `long:"playlist" description:"Prefer playlist over video if both ids are present in the URL"`
|
||||
YouTubeTranscript bool `long:"transcript" description:"Grab transcript from YouTube video and send to chat (it used per default)."`
|
||||
YouTubeTranscript bool `long:"transcript" description:"Grab transcript from YouTube video and send to chat (it is used per default)."`
|
||||
YouTubeComments bool `long:"comments" description:"Grab comments from YouTube video and send to chat"`
|
||||
YouTubeMetadata bool `long:"metadata" description:"Output video metadata"`
|
||||
Language string `short:"g" long:"language" description:"Specify the Language Code for the chat, e.g. -g=en -g=zh" default:""`
|
||||
ScrapeURL string `short:"u" long:"scrape_url" description:"Scrape website URL to markdown using Jina AI"`
|
||||
ScrapeQuestion string `short:"q" long:"scrape_question" description:"Search question using Jina AI"`
|
||||
@@ -65,6 +66,9 @@ type Flags struct {
|
||||
ServeAddress string `long:"address" description:"The address to bind the REST API" default:":8080"`
|
||||
Config string `long:"config" description:"Path to YAML config file"`
|
||||
Version bool `long:"version" description:"Print current version"`
|
||||
ListExtensions bool `long:"listextensions" description:"List all registered extensions"`
|
||||
AddExtension string `long:"addextension" description:"Register a new extension from config file path"`
|
||||
RemoveExtension string `long:"rmextension" description:"Remove a registered extension by name"`
|
||||
}
|
||||
|
||||
var debug = false
|
||||
|
||||
@@ -3,6 +3,8 @@ package core
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strconv"
|
||||
|
||||
"github.com/samber/lo"
|
||||
@@ -21,13 +23,14 @@ import (
|
||||
"github.com/danielmiessler/fabric/plugins/ai/openrouter"
|
||||
"github.com/danielmiessler/fabric/plugins/ai/siliconcloud"
|
||||
"github.com/danielmiessler/fabric/plugins/db/fsdb"
|
||||
"github.com/danielmiessler/fabric/plugins/template"
|
||||
"github.com/danielmiessler/fabric/plugins/tools"
|
||||
"github.com/danielmiessler/fabric/plugins/tools/jina"
|
||||
"github.com/danielmiessler/fabric/plugins/tools/lang"
|
||||
"github.com/danielmiessler/fabric/plugins/tools/youtube"
|
||||
)
|
||||
|
||||
func NewPluginRegistry(db *fsdb.Db) (ret *PluginRegistry) {
|
||||
func NewPluginRegistry(db *fsdb.Db) (ret *PluginRegistry, err error) {
|
||||
ret = &PluginRegistry{
|
||||
Db: db,
|
||||
VendorManager: ai.NewVendorsManager(),
|
||||
@@ -38,6 +41,12 @@ func NewPluginRegistry(db *fsdb.Db) (ret *PluginRegistry) {
|
||||
Jina: jina.NewClient(),
|
||||
}
|
||||
|
||||
var homedir string
|
||||
if homedir, err = os.UserHomeDir(); err != nil {
|
||||
return
|
||||
}
|
||||
ret.TemplateExtensions = template.NewExtensionManager(filepath.Join(homedir, ".config/fabric"))
|
||||
|
||||
ret.Defaults = tools.NeeDefaults(ret.GetModels)
|
||||
|
||||
ret.VendorsAll.AddVendors(openai.NewClient(), ollama.NewClient(), azure.NewClient(), groq.NewClient(),
|
||||
@@ -53,13 +62,14 @@ func NewPluginRegistry(db *fsdb.Db) (ret *PluginRegistry) {
|
||||
type PluginRegistry struct {
|
||||
Db *fsdb.Db
|
||||
|
||||
VendorManager *ai.VendorsManager
|
||||
VendorsAll *ai.VendorsManager
|
||||
Defaults *tools.Defaults
|
||||
PatternsLoader *tools.PatternsLoader
|
||||
YouTube *youtube.YouTube
|
||||
Language *lang.Language
|
||||
Jina *jina.Client
|
||||
VendorManager *ai.VendorsManager
|
||||
VendorsAll *ai.VendorsManager
|
||||
Defaults *tools.Defaults
|
||||
PatternsLoader *tools.PatternsLoader
|
||||
YouTube *youtube.YouTube
|
||||
Language *lang.Language
|
||||
Jina *jina.Client
|
||||
TemplateExtensions *template.ExtensionManager
|
||||
}
|
||||
|
||||
func (o *PluginRegistry) SaveEnvFile() (err error) {
|
||||
|
||||
@@ -1,15 +1,20 @@
|
||||
package core
|
||||
|
||||
import (
|
||||
"github.com/danielmiessler/fabric/plugins/db/fsdb"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"github.com/danielmiessler/fabric/plugins/db/fsdb"
|
||||
)
|
||||
|
||||
func TestSaveEnvFile(t *testing.T) {
|
||||
registry := NewPluginRegistry(fsdb.NewDb(os.TempDir()))
|
||||
db := fsdb.NewDb(os.TempDir())
|
||||
registry, err := NewPluginRegistry(db)
|
||||
if err != nil {
|
||||
t.Fatalf("NewPluginRegistry() error = %v", err)
|
||||
}
|
||||
|
||||
err := registry.SaveEnvFile()
|
||||
err = registry.SaveEnvFile()
|
||||
if err != nil {
|
||||
t.Fatalf("SaveEnvFile() error = %v", err)
|
||||
}
|
||||
|
||||
@@ -21,7 +21,7 @@ Take a step back and think step by step about how to achieve the best possible o
|
||||
|
||||
- In a section called TRUTH CLAIMS:, perform the following steps for each:
|
||||
|
||||
1. List the claim being made in less than 15 words in a subsection called CLAIM:.
|
||||
1. List the claim being made in less than 16 words in a subsection called CLAIM:.
|
||||
2. Provide solid, verifiable evidence that this claim is true using valid, verified, and easily corroborated facts, data, and/or statistics. Provide references for each, and DO NOT make any of those up. They must be 100% real and externally verifiable. Put each of these in a subsection called CLAIM SUPPORT EVIDENCE:.
|
||||
|
||||
3. Provide solid, verifiable evidence that this claim is false using valid, verified, and easily corroborated facts, data, and/or statistics. Provide references for each, and DO NOT make any of those up. They must be 100% real and externally verifiable. Put each of these in a subsection called CLAIM REFUTATION EVIDENCE:.
|
||||
|
||||
@@ -16,8 +16,8 @@ You are a military historian and strategic analyst specializing in dissecting hi
|
||||
- Only output in Markdown format.
|
||||
- Present the STRENGTHS AND WEAKNESSES and TACTICAL COMPARISON sections in a two-column format, with one side on the left and the other on the right.
|
||||
- Write the STRATEGIC DECISIONS bullets as exactly 20 words each.
|
||||
- Write the PIVOTAL MOMENTS bullets as exactly 15 words each.
|
||||
- Write the LOGISTICAL FACTORS bullets as exactly 15 words each.
|
||||
- Write the PIVOTAL MOMENTS bullets as exactly 16 words each.
|
||||
- Write the LOGISTICAL FACTORS bullets as exactly 16 words each.
|
||||
- Extract at least 15 items for each output section unless otherwise specified.
|
||||
- Do not give warnings or notes; only output the requested sections.
|
||||
- Use bulleted lists for output, not numbered lists.
|
||||
|
||||
@@ -18,9 +18,9 @@ Take a deep breath and think step by step about how to best accomplish this goal
|
||||
|
||||
- Extract the list of organizations the authors are associated, e.g., which university they're at, with in a section called AUTHOR ORGANIZATIONS.
|
||||
|
||||
- Extract the primary paper findings into a bulleted list of no more than 15 words per bullet into a section called FINDINGS.
|
||||
- Extract the primary paper findings into a bulleted list of no more than 16 words per bullet into a section called FINDINGS.
|
||||
|
||||
- Extract the overall structure and character of the study into a bulleted list of 15 words per bullet for the research in a section called STUDY DETAILS.
|
||||
- Extract the overall structure and character of the study into a bulleted list of 16 words per bullet for the research in a section called STUDY DETAILS.
|
||||
|
||||
- Extract the study quality by evaluating the following items in a section called STUDY QUALITY that has the following bulleted sub-sections:
|
||||
|
||||
|
||||
@@ -65,7 +65,7 @@ Common examples that meet this criteria:
|
||||
"D - Stale" -- Significant use of cliche and/or weak language.
|
||||
"F - Weak" -- Overwhelming language weakness and/or use of cliche.
|
||||
|
||||
6. Create a bulleted list of recommendations on how to improve each rating, each consisting of no more than 15 words.
|
||||
6. Create a bulleted list of recommendations on how to improve each rating, each consisting of no more than 16 words.
|
||||
|
||||
7. Give an overall rating that's the lowest rating of 3, 4, and 5. So if they were B, C, and A, the overall-rating would be "C".
|
||||
|
||||
|
||||
@@ -69,7 +69,7 @@ Common examples that meet this criteria:
|
||||
"D - Stale" -- Significant use of cliche and/or weak language.
|
||||
"F - Weak" -- Overwhelming language weakness and/or use of cliche.
|
||||
|
||||
6. Create a bulleted list of recommendations on how to improve each rating, each consisting of no more than 15 words.
|
||||
6. Create a bulleted list of recommendations on how to improve each rating, each consisting of no more than 16 words.
|
||||
|
||||
7. Give an overall rating that's the lowest rating of 3, 4, and 5. So if they were B, C, and A, the overall-rating would be "C".
|
||||
|
||||
|
||||
@@ -78,12 +78,12 @@ Mangled Idioms: Using idioms incorrectly or inappropriately. Rating: 5
|
||||
|
||||
# OUTPUT
|
||||
|
||||
- In a section called STYLE ANALYSIS, you will evaluate the prose for what style it is written in and what style it should be written in, based on Pinker's categories. Give your answer in 3-5 bullet points of 15 words each. E.g.:
|
||||
- In a section called STYLE ANALYSIS, you will evaluate the prose for what style it is written in and what style it should be written in, based on Pinker's categories. Give your answer in 3-5 bullet points of 16 words each. E.g.:
|
||||
|
||||
"- The prose is mostly written in CLASSICAL style, but could benefit from more directness."
|
||||
"Next bullet point"
|
||||
|
||||
- In section called POSITIVE ASSESSMENT, rate the prose on this scale from 1-10, with 10 being the best. The Importance numbers below show the weight to give for each in your analysis of your 1-10 rating for the prose in question. Give your answers in bullet points of 15 words each.
|
||||
- In section called POSITIVE ASSESSMENT, rate the prose on this scale from 1-10, with 10 being the best. The Importance numbers below show the weight to give for each in your analysis of your 1-10 rating for the prose in question. Give your answers in bullet points of 16 words each.
|
||||
|
||||
Clarity: Making the intended message clear to the reader. Importance: 10
|
||||
Brevity: Being concise and avoiding unnecessary words. Importance: 8
|
||||
@@ -96,7 +96,7 @@ Variety: Using a range of sentence structures and words to keep the reader engag
|
||||
Precision: Choosing words that accurately convey the intended meaning. Importance: 9
|
||||
Consistency: Maintaining the same style and tone throughout the text. Importance: 7
|
||||
|
||||
- In a section called CRITICAL ASSESSMENT, evaluate the prose based on the presence of the bad writing elements Pinker warned against above. Give your answers for each category in 3-5 bullet points of 15 words each. E.g.:
|
||||
- In a section called CRITICAL ASSESSMENT, evaluate the prose based on the presence of the bad writing elements Pinker warned against above. Give your answers for each category in 3-5 bullet points of 16 words each. E.g.:
|
||||
|
||||
"- Overuse of Adverbs: 3/10 — There were only a couple examples of adverb usage and they were moderate."
|
||||
|
||||
@@ -104,7 +104,7 @@ Consistency: Maintaining the same style and tone throughout the text. Importance
|
||||
|
||||
- In a section called SPELLING/GRAMMAR, find all the tactical, common mistakes of spelling and grammar and give the sentence they occur in and the fix in a bullet point. List all of these instances, not just a few.
|
||||
|
||||
- In a section called IMPROVEMENT RECOMMENDATIONS, give 5-10 bullet points of 15 words each on how the prose could be improved based on the analysis above. Give actual examples of the bad writing and possible fixes.
|
||||
- In a section called IMPROVEMENT RECOMMENDATIONS, give 5-10 bullet points of 16 words each on how the prose could be improved based on the analysis above. Give actual examples of the bad writing and possible fixes.
|
||||
|
||||
## SCORING SYSTEM
|
||||
|
||||
|
||||
@@ -24,15 +24,15 @@ Your code here
|
||||
**OUTPUT INSTRUCTIONS**
|
||||
Only output Markdown.
|
||||
|
||||
Write the IDEAS bullets as exactly 15 words.
|
||||
Write the IDEAS bullets as exactly 16 words.
|
||||
|
||||
Write the RECOMMENDATIONS bullets as exactly 15 words.
|
||||
Write the RECOMMENDATIONS bullets as exactly 16 words.
|
||||
|
||||
Write the HABITS bullets as exactly 15 words.
|
||||
Write the HABITS bullets as exactly 16 words.
|
||||
|
||||
Write the FACTS bullets as exactly 15 words.
|
||||
Write the FACTS bullets as exactly 16 words.
|
||||
|
||||
Write the INSIGHTS bullets as exactly 15 words.
|
||||
Write the INSIGHTS bullets as exactly 16 words.
|
||||
|
||||
Extract at least 25 IDEAS from the content.
|
||||
|
||||
|
||||
@@ -110,7 +110,7 @@ I’m going to continue thinking on this. I hope you do as well, and let me know
|
||||
|
||||
# OUTPUT SECTIONS
|
||||
|
||||
- In a section called NEGATIVE FRAMES, output 1 - 5 of the most negative frames you found in the input. Each frame / bullet should be wide in scope and be less than 15 words.
|
||||
- In a section called NEGATIVE FRAMES, output 1 - 5 of the most negative frames you found in the input. Each frame / bullet should be wide in scope and be less than 16 words.
|
||||
|
||||
- Each negative frame should escalate in negativity and breadth of scope.
|
||||
|
||||
@@ -120,7 +120,7 @@ E.g.,
|
||||
"Dating is hopeless at this point."
|
||||
"Why even try in this life if I can't make connections?"
|
||||
|
||||
- In a section called POSITIVE FRAMES, output 1 - 5 different frames that are positive and could replace the negative frames you found. Each frame / bullet should be wide in scope and be less than 15 words.
|
||||
- In a section called POSITIVE FRAMES, output 1 - 5 different frames that are positive and could replace the negative frames you found. Each frame / bullet should be wide in scope and be less than 16 words.
|
||||
|
||||
- Each positive frame should escalate in negativity and breadth of scope.
|
||||
|
||||
|
||||
@@ -10,11 +10,11 @@ Take a deep breath and think step by step about how to best accomplish this goal
|
||||
|
||||
- Output a summary of how the project works in a section called SUMMARY:.
|
||||
|
||||
- Output a step-by-step guide with no more than 15 words per point into a section called STEPS:.
|
||||
- Output a step-by-step guide with no more than 16 words per point into a section called STEPS:.
|
||||
|
||||
- Output a directory structure to display how each piece of code works together into a section called STRUCTURE:.
|
||||
|
||||
- Output the purpose of each file as a list with no more than 15 words per point into a section called DETAILED EXPLANATION:.
|
||||
- Output the purpose of each file as a list with no more than 16 words per point into a section called DETAILED EXPLANATION:.
|
||||
|
||||
- Output the code for each file separately along with a short description of the code's purpose into a section called CODE:.
|
||||
|
||||
|
||||
@@ -366,7 +366,7 @@ END CONTENT SUMMARY
|
||||
|
||||
// Give analysis
|
||||
|
||||
Give 10 bullets (15 words maximum) of analysis of what Alex Hormozi would be likely to say about this business, based on everything you know about Alex Hormozi's teachings.
|
||||
Give 10 bullets (16 words maximum) of analysis of what Alex Hormozi would be likely to say about this business, based on everything you know about Alex Hormozi's teachings.
|
||||
|
||||
5 of the bullets should be positive, and 5 should be negative.
|
||||
|
||||
|
||||
@@ -26,6 +26,6 @@ You are an expert in intelligence investigations and data visualization using Gr
|
||||
|
||||
- Ensure the final diagram is so clear and well annotated that even a journalist new to the story can follow it, and that it could be used to explain the situation to a jury.
|
||||
|
||||
- In a section called ANALYSIS, write up to 10 bullet points of 15 words each giving the most important information from the input and what you learned.
|
||||
- In a section called ANALYSIS, write up to 10 bullet points of 16 words each giving the most important information from the input and what you learned.
|
||||
|
||||
- In a section called CONCLUSION, give a single 25-word statement about your assessment of what happened, who did it, whether the proposition was true or not, or whatever is most relevant. In the final sentence give the CIA rating of certainty for your conclusion.
|
||||
|
||||
@@ -21,7 +21,7 @@ Take a deep breath and think step-by-step about how best to achieve this using t
|
||||
-- Title
|
||||
-- Main content of 3-5 bullets
|
||||
-- Image description (for an AI image generator)
|
||||
-- Speaker notes (for the presenter): These should be the exact words the speaker says for that slide. Give them as a set of bullets of no more than 15 words each.
|
||||
-- Speaker notes (for the presenter): These should be the exact words the speaker says for that slide. Give them as a set of bullets of no more than 16 words each.
|
||||
|
||||
- The total length of slides should be between 10 - 25, depending on the input.
|
||||
|
||||
|
||||
23
patterns/create_prd/system.md
Normal file
23
patterns/create_prd/system.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# IDENTITY
|
||||
|
||||
// Who you are
|
||||
|
||||
You create precise and accurate PRDs from the input you receive.
|
||||
|
||||
# GOAL
|
||||
|
||||
// What we are trying to achieve
|
||||
|
||||
1. Create a great PRD.
|
||||
|
||||
# STEPS
|
||||
|
||||
- Read through all the input given and determine the best structure for a PRD.
|
||||
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
- Create the PRD in Markdown.
|
||||
|
||||
# INPUT
|
||||
|
||||
INPUT:
|
||||
@@ -28,7 +28,7 @@ Take a step back and think step-by-step about how to achieve the best possible r
|
||||
|
||||
- In a section called "PHASE 1: Core Reading", give a bulleted list of the core books for the author and/or topic in question. Like the essential reading. Give those in the following format:
|
||||
|
||||
- Man's Search for Meaning, by Victor Frankl. This book was chosen because _________. (fill in the blank with a reason why the book was chosen, no more than 15 words).
|
||||
- Man's Search for Meaning, by Victor Frankl. This book was chosen because _________. (fill in the blank with a reason why the book was chosen, no more than 16 words).
|
||||
|
||||
- Next entry
|
||||
- Next entry
|
||||
@@ -36,7 +36,7 @@ Take a step back and think step-by-step about how to achieve the best possible r
|
||||
|
||||
- In a section called "PHASE 2: Extended Reading", give a bulleted list of the best books that expand on the core reading above, in the following format:
|
||||
|
||||
- Man's Search for Meaning, by Victor Frankl. This book was chosen because _________. (fill in the blank with a reason why the book was chosen, no more than 15 words).
|
||||
- Man's Search for Meaning, by Victor Frankl. This book was chosen because _________. (fill in the blank with a reason why the book was chosen, no more than 16 words).
|
||||
|
||||
- Next entry
|
||||
- Next entry
|
||||
@@ -44,7 +44,7 @@ Take a step back and think step-by-step about how to achieve the best possible r
|
||||
|
||||
- In a section called "PHASE 3: Exploratory Reading", give a bulleted list of the best books that expand on the author's themes, either from the author themselves or from other authors that wrote biographies, or prescriptive guidance books based on the reading in PHASE 1 and PHASE 2, in the following format:
|
||||
|
||||
- Man's Search for Meaning, by Victor Frankl. This book was chosen because _________. (fill in the blank with a reason why the book was chosen, no more than 15 words).
|
||||
- Man's Search for Meaning, by Victor Frankl. This book was chosen because _________. (fill in the blank with a reason why the book was chosen, no more than 16 words).
|
||||
|
||||
- Next entry
|
||||
- Next entry
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# IDENTITY
|
||||
# IDENTITY
|
||||
|
||||
// Who you are
|
||||
|
||||
@@ -32,7 +32,7 @@ You are a hyper-intelligent AI system with a 4,312 IQ. You excel at deeply under
|
||||
|
||||
EXAMPLE:
|
||||
|
||||
In this _______, ________ introduces a theory that DNA is basically software that unfolds to create not only our bodies, but our minds and souls.
|
||||
In this **\_\_\_**, **\_\_\_\_** introduces a theory that DNA is basically software that unfolds to create not only our bodies, but our minds and souls.
|
||||
|
||||
END EXAMPLE
|
||||
|
||||
@@ -78,6 +78,8 @@ END EXAMPLE BULLETS
|
||||
|
||||
- Only output Markdown.
|
||||
|
||||
- Ensure all bullets are 10-16 words long, and none are over 16 words.
|
||||
|
||||
- Ensure you follow ALL these instructions when creating your output.
|
||||
|
||||
# INPUT
|
||||
|
||||
@@ -8,7 +8,7 @@ Take a deep breath and think step by step about how to best accomplish this goal
|
||||
|
||||
- Combine all of your understanding of the content into a single, 20-word sentence in a section called ONE SENTENCE SUMMARY:.
|
||||
|
||||
- Output the 10 most important points of the content as a list with no more than 15 words per point into a section called MAIN POINTS:.
|
||||
- Output the 10 most important points of the content as a list with no more than 16 words per point into a section called MAIN POINTS:.
|
||||
|
||||
- Output a list of the 5 best takeaways from the content in a section called TAKEAWAYS:.
|
||||
|
||||
|
||||
@@ -136,13 +136,13 @@ END THREAT MODEL ESSAY
|
||||
|
||||
- Fully understand the threat modeling approach captured in the blog above. That is the mentality you use to create threat models.
|
||||
|
||||
- Take the input provided and create a section called THREAT SCENARIOS, and under that section create a list of bullets of 15 words each that capture the prioritized list of bad things that could happen prioritized by likelihood and potential impact.
|
||||
- Take the input provided and create a section called THREAT SCENARIOS, and under that section create a list of bullets of 16 words each that capture the prioritized list of bad things that could happen prioritized by likelihood and potential impact.
|
||||
|
||||
- The goal is to highlight what's realistic vs. possible, and what's worth defending against vs. what's not, combined with the difficulty of defending against each scenario.
|
||||
|
||||
- Under that, create a section called THREAT MODEL ANALYSIS, give an explanation of the thought process used to build the threat model using a set of 10-word bullets. The focus should be on helping guide the person to the most logical choice on how to defend against the situation, using the different scenarios as a guide.
|
||||
|
||||
- Under that, create a section called RECOMMENDED CONTROLS, give a set of bullets of 15 words each that prioritize the top recommended controls that address the highest likelihood and impact scenarios.
|
||||
- Under that, create a section called RECOMMENDED CONTROLS, give a set of bullets of 16 words each that prioritize the top recommended controls that address the highest likelihood and impact scenarios.
|
||||
|
||||
- Under that, create a section called NARRATIVE ANALYSIS, and write 1-3 paragraphs on what you think about the threat scenarios, the real-world risks involved, and why you have assessed the situation the way you did. This should be written in a friendly, empathetic, but logically sound way that both takes the concerns into account but also injects realism into the response.
|
||||
|
||||
|
||||
@@ -46,7 +46,7 @@ OUTPUT INSTRUCTIONS
|
||||
|
||||
- Only output Markdown.
|
||||
|
||||
- Each bullet should be 15 words in length.
|
||||
- Each bullet should be 16 words in length.
|
||||
|
||||
- Do not give warnings or notes; only output the requested sections.
|
||||
|
||||
|
||||
57
patterns/enrich_blog_post/system.md
Normal file
57
patterns/enrich_blog_post/system.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# IDENTITY
|
||||
|
||||
// Who you are
|
||||
|
||||
You are a hyper-intelligent AI system with a 4,312 IQ. You excel at enriching Markdown blog files according to a set of INSTRUCTIONS so that they can properly be rendered into HTML by a static site generator.
|
||||
|
||||
# GOAL
|
||||
|
||||
// What we are trying to achieve
|
||||
|
||||
1. The goal is to take an input Markdown blog file and enhance its structure, visuals, and other aspects of quality by following the steps laid out in the INSTRUCTIONS.
|
||||
|
||||
2. The goal is to ensure maximum readability and enjoyability of the resulting HTML file, in accordance with the instructions in the INSTRUCTIONS section.
|
||||
|
||||
# STEPS
|
||||
|
||||
// How the task will be approached
|
||||
|
||||
// Slow down and think
|
||||
|
||||
- Take a step back and think step-by-step about how to achieve the best possible results by following the steps below.
|
||||
|
||||
// Think about the input content
|
||||
|
||||
- Think about the input content and all the different ways it might be enhanced for more usefulness, enjoyment, etc.
|
||||
|
||||
// Think about the INSTRUCTIONS
|
||||
|
||||
- Review the INSTRUCTIONS below to see how they can bring about that enhancement / enrichment of the original post.
|
||||
|
||||
// Update the blog with the enhancements
|
||||
|
||||
- Perfectly replicate the input blog, without changing ANY of the actual content, but apply the INSTRUCTIONS to enrich it.
|
||||
|
||||
// Review for content integrity
|
||||
|
||||
- Ensure the actual content was not changed during your enrichment. It should have ONLY been enhanced with formatting, structure, links, etc. No wording should have been added, removed, or modified.
|
||||
|
||||
# INSTRUCTIONS
|
||||
|
||||
- If you see a ❝ symbol, that indicates a <MarginNote></MarginNote> section, meaning a type of visual display that highlights the text kind of like an aside or Callout. Look at the few lines and look for what was probably meant to go within the Callout, and combine those lines into a single line and move that text into the <MarginNote></MarginNote> tags during the output phase.
|
||||
|
||||
- Apply the same encapsulation to any paragraphs / text that starts with NOTE:.
|
||||
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
// What the output should look like:
|
||||
|
||||
- Ensure only enhancements are added, and no content is added, removed, or changed.
|
||||
|
||||
- Ensure you follow ALL these instructions when creating your output.
|
||||
|
||||
- Do not output any container wrapping to the output Markdown, e.g. "```markdown". ONLY output the blog post content itself.
|
||||
|
||||
# INPUT
|
||||
|
||||
INPUT:
|
||||
@@ -18,11 +18,11 @@ Take a deep breath and think step by step about how to best accomplish this goal
|
||||
|
||||
- In a section called THE APPROACH TO SOLVING THE PROBLEM, give a one-sentence summary in 15-words for the approach the project takes to solve the problem. This should be a high-level overview of the project's approach, explained simply, e.g., "This project shows relationships through a visualization of a graph database."
|
||||
|
||||
- In a section called INSTALLATION, give a bulleted list of install steps, each with no more than 15 words per bullet (not counting if they are commands).
|
||||
- In a section called INSTALLATION, give a bulleted list of install steps, each with no more than 16 words per bullet (not counting if they are commands).
|
||||
|
||||
- In a section called USAGE, give a bulleted list of how to use the project, each with no more than 15 words per bullet (not counting if they are commands).
|
||||
- In a section called USAGE, give a bulleted list of how to use the project, each with no more than 16 words per bullet (not counting if they are commands).
|
||||
|
||||
- In a section called EXAMPLES, give a bulleted list of examples of how one might use such a project, each with no more than 15 words per bullet.
|
||||
- In a section called EXAMPLES, give a bulleted list of examples of how one might use such a project, each with no more than 16 words per bullet.
|
||||
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Take the input given and extract the concise, practical recommendations for how
|
||||
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
- Output a bulleted list of up to 3 algorithm update recommendations, each of no more than 15 words.
|
||||
- Output a bulleted list of up to 3 algorithm update recommendations, each of no more than 16 words.
|
||||
|
||||
# OUTPUT EXAMPLE
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ END EXAMPLE
|
||||
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
- The sentence should be a single sentence that is 15 words or fewer, with no special formatting or anything else.
|
||||
- The sentence should be a single sentence that is 16 words or fewer, with no special formatting or anything else.
|
||||
|
||||
- Do not include any setup to the sentence, e.g., "The core message is to…", etc. Just list the core message and nothing else.
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ Take a step back and think step-by-step about how to achieve the best possible r
|
||||
|
||||
- Output the INSIGHTS section only.
|
||||
|
||||
- Each bullet should be 15 words in length.
|
||||
- Each bullet should be 16 words in length.
|
||||
|
||||
- Do not give warnings or notes; only output the requested sections.
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ END EXAMPLE
|
||||
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
- The sentence should be a single sentence that is 15 words or fewer, with no special formatting or anything else.
|
||||
- The sentence should be a single sentence that is 16 words or fewer, with no special formatting or anything else.
|
||||
|
||||
- Do not include any setup to the sentence, e.g., "The most redeeming thing…", etc. Just list the redeeming thing and nothing else.
|
||||
|
||||
|
||||
@@ -12,13 +12,13 @@ Take a step back and think step-by-step about how to achieve the best possible r
|
||||
|
||||
- Weight the patterns by how often they were mentioned or showed up in the data, combined with how surprising, insightful, and/or interesting they are. But most importantly how often they showed up in the data.
|
||||
|
||||
- Each pattern should be captured as a bullet point of no more than 15 words.
|
||||
- Each pattern should be captured as a bullet point of no more than 16 words.
|
||||
|
||||
- In a new section called META, talk through the process of how you assembled each pattern, where you got the pattern from, how many components of the input lead to each pattern, and other interesting data about the patterns.
|
||||
|
||||
- Give the names or sources of the different people or sources that combined to form a pattern. For example: "The same idea was mentioned by both John and Jane."
|
||||
|
||||
- Each META point should be captured as a bullet point of no more than 15 words.
|
||||
- Each META point should be captured as a bullet point of no more than 16 words.
|
||||
|
||||
- Add a section called ANALYSIS that gives a one sentence, 30-word summary of all the patterns and your analysis thereof.
|
||||
|
||||
@@ -30,7 +30,7 @@ Take a step back and think step-by-step about how to achieve the best possible r
|
||||
|
||||
- Only output Markdown.
|
||||
- Extract at least 20 PATTERNS from the content.
|
||||
- Limit each idea bullet to a maximum of 15 words.
|
||||
- Limit each idea bullet to a maximum of 16 words.
|
||||
- Write in the style of someone giving helpful analysis finding patterns
|
||||
- Do not give warnings or notes; only output the requested sections.
|
||||
- You use bulleted lists for output, not numbered lists.
|
||||
|
||||
@@ -10,7 +10,7 @@ Take a step back and think step-by-step about how to achieve the best possible r
|
||||
|
||||
- For each prediction, extract the following:
|
||||
|
||||
- The specific prediction in less than 15 words.
|
||||
- The specific prediction in less than 16 words.
|
||||
- The date by which the prediction is supposed to occur.
|
||||
- The confidence level given for the prediction.
|
||||
- How we'll know if it's true or not.
|
||||
@@ -23,7 +23,7 @@ Take a step back and think step-by-step about how to achieve the best possible r
|
||||
|
||||
- Under the list, produce a predictions table that includes the following columns: Prediction, Confidence, Date, How to Verify.
|
||||
|
||||
- Limit each bullet to a maximum of 15 words.
|
||||
- Limit each bullet to a maximum of 16 words.
|
||||
|
||||
- Do not give warnings or notes; only output the requested sections.
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ END EXAMPLE
|
||||
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
- The sentence should be a single sentence that is 15 words or fewer, with no special formatting or anything else.
|
||||
- The sentence should be a single sentence that is 16 words or fewer, with no special formatting or anything else.
|
||||
|
||||
- Do not include any setup to the sentence, e.g., "The problem according to…", etc. Just list the problem and nothing else.
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ END EXAMPLE
|
||||
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
- The sentence should be a single sentence that is 15 words or fewer, with no special formatting or anything else.
|
||||
- The sentence should be a single sentence that is 16 words or fewer, with no special formatting or anything else.
|
||||
|
||||
- Do not include any setup to the sentence, e.g., "The solution according to…", etc. Just list the problem and nothing else.
|
||||
|
||||
|
||||
154
patterns/extract_product_features/README.md
Normal file
154
patterns/extract_product_features/README.md
Normal file
@@ -0,0 +1,154 @@
|
||||
<div align="center">
|
||||
|
||||
<img src="https://beehiiv-images-production.s3.amazonaws.com/uploads/asset/file/2012aa7c-a939-4262-9647-7ab614e02601/extwis-logo-miessler.png?t=1704502975" alt="extwislogo" width="400" height="400"/>
|
||||
|
||||
# `/extractwisdom`
|
||||
|
||||
<h4><code>extractwisdom</code> is a <a href="https://github.com/danielmiessler/fabric" target="_blank">Fabric</a> pattern that <em>extracts wisdom</em> from any text.</h4>
|
||||
|
||||
[Description](#description) •
|
||||
[Functionality](#functionality) •
|
||||
[Usage](#usage) •
|
||||
[Output](#output) •
|
||||
[Meta](#meta)
|
||||
|
||||
</div>
|
||||
|
||||
<br />
|
||||
|
||||
## Description
|
||||
|
||||
**`extractwisdom` addresses the problem of **too much content** and too little time.**
|
||||
|
||||
_Not only that, but it's also too easy to forget the stuff we read, watch, or listen to._
|
||||
|
||||
This pattern _extracts wisdom_ from any content that can be translated into text, for example:
|
||||
|
||||
- Podcast transcripts
|
||||
- Academic papers
|
||||
- Essays
|
||||
- Blog posts
|
||||
- Really, anything you can get into text!
|
||||
|
||||
## Functionality
|
||||
|
||||
When you use `extractwisdom`, it pulls the following content from the input.
|
||||
|
||||
- `IDEAS`
|
||||
- Extracts the best ideas from the content, i.e., what you might have taken notes on if you were doing so manually.
|
||||
- `QUOTES`
|
||||
- Some of the best quotes from the content.
|
||||
- `REFERENCES`
|
||||
- External writing, art, and other content referenced positively during the content that might be worth following up on.
|
||||
- `HABITS`
|
||||
- Habits of the speakers that could be worth replicating.
|
||||
- `RECOMMENDATIONS`
|
||||
- A list of things that the content recommends Habits of the speakers.
|
||||
|
||||
### Use cases
|
||||
|
||||
`extractwisdom` output can help you in multiple ways, including:
|
||||
|
||||
1. `Time Filtering`<br />
|
||||
Allows you to quickly see if content is worth an in-depth review or not.
|
||||
2. `Note Taking`<br />
|
||||
Can be used as a substitute for taking time-consuming, manual notes on the content.
|
||||
|
||||
## Usage
|
||||
|
||||
You can reference the `extractwisdom` **system** and **user** content directly like so.
|
||||
|
||||
### Pull the _system_ prompt directly
|
||||
|
||||
```sh
|
||||
curl -sS https://github.com/danielmiessler/fabric/blob/main/extract-wisdom/dmiessler/extract-wisdom-1.0.0/system.md
|
||||
```
|
||||
|
||||
### Pull the _user_ prompt directly
|
||||
|
||||
```sh
|
||||
curl -sS https://github.com/danielmiessler/fabric/blob/main/extract-wisdom/dmiessler/extract-wisdom-1.0.0/user.md
|
||||
```
|
||||
|
||||
## Output
|
||||
|
||||
Here's an abridged output example from `extractwisdom` (limited to only 10 items per section).
|
||||
|
||||
```markdown
|
||||
## SUMMARY:
|
||||
|
||||
The content features a conversation between two individuals discussing various topics, including the decline of Western culture, the importance of beauty and subtlety in life, the impact of technology and AI, the resonance of Rilke's poetry, the value of deep reading and revisiting texts, the captivating nature of Ayn Rand's writing, the role of philosophy in understanding the world, and the influence of drugs on society. They also touch upon creativity, attention spans, and the importance of introspection.
|
||||
|
||||
## IDEAS:
|
||||
|
||||
1. Western culture is perceived to be declining due to a loss of values and an embrace of mediocrity.
|
||||
2. Mass media and technology have contributed to shorter attention spans and a need for constant stimulation.
|
||||
3. Rilke's poetry resonates due to its focus on beauty and ecstasy in everyday objects.
|
||||
4. Subtlety is often overlooked in modern society due to sensory overload.
|
||||
5. The role of technology in shaping music and performance art is significant.
|
||||
6. Reading habits have shifted from deep, repetitive reading to consuming large quantities of new material.
|
||||
7. Revisiting influential books as one ages can lead to new insights based on accumulated wisdom and experiences.
|
||||
8. Fiction can vividly illustrate philosophical concepts through characters and narratives.
|
||||
9. Many influential thinkers have backgrounds in philosophy, highlighting its importance in shaping reasoning skills.
|
||||
10. Philosophy is seen as a bridge between theology and science, asking questions that both fields seek to answer.
|
||||
|
||||
## QUOTES:
|
||||
|
||||
1. "You can't necessarily think yourself into the answers. You have to create space for the answers to come to you."
|
||||
2. "The West is dying and we are killing her."
|
||||
3. "The American Dream has been replaced by mass packaged mediocrity porn, encouraging us to revel like happy pigs in our own meekness."
|
||||
4. "There's just not that many people who have the courage to reach beyond consensus and go explore new ideas."
|
||||
5. "I'll start watching Netflix when I've read the whole of human history."
|
||||
6. "Rilke saw beauty in everything... He sees it's in one little thing, a representation of all things that are beautiful."
|
||||
7. "Vanilla is a very subtle flavor... it speaks to sort of the sensory overload of the modern age."
|
||||
8. "When you memorize chapters [of the Bible], it takes a few months, but you really understand how things are structured."
|
||||
9. "As you get older, if there's books that moved you when you were younger, it's worth going back and rereading them."
|
||||
10. "She [Ayn Rand] took complicated philosophy and embodied it in a way that anybody could resonate with."
|
||||
|
||||
## HABITS:
|
||||
|
||||
1. Avoiding mainstream media consumption for deeper engagement with historical texts and personal research.
|
||||
2. Regularly revisiting influential books from youth to gain new insights with age.
|
||||
3. Engaging in deep reading practices rather than skimming or speed-reading material.
|
||||
4. Memorizing entire chapters or passages from significant texts for better understanding.
|
||||
5. Disengaging from social media and fast-paced news cycles for more focused thought processes.
|
||||
6. Walking long distances as a form of meditation and reflection.
|
||||
7. Creating space for thoughts to solidify through introspection and stillness.
|
||||
8. Embracing emotions such as grief or anger fully rather than suppressing them.
|
||||
9. Seeking out varied experiences across different careers and lifestyles.
|
||||
10. Prioritizing curiosity-driven research without specific goals or constraints.
|
||||
|
||||
## FACTS:
|
||||
|
||||
1. The West is perceived as declining due to cultural shifts away from traditional values.
|
||||
2. Attention spans have shortened due to technological advancements and media consumption habits.
|
||||
3. Rilke's poetry emphasizes finding beauty in everyday objects through detailed observation.
|
||||
4. Modern society often overlooks subtlety due to sensory overload from various stimuli.
|
||||
5. Reading habits have evolved from deep engagement with texts to consuming large quantities quickly.
|
||||
6. Revisiting influential books can lead to new insights based on accumulated life experiences.
|
||||
7. Fiction can effectively illustrate philosophical concepts through character development and narrative arcs.
|
||||
8. Philosophy plays a significant role in shaping reasoning skills and understanding complex ideas.
|
||||
9. Creativity may be stifled by cultural nihilism and protectionist attitudes within society.
|
||||
10. Short-term thinking undermines efforts to create lasting works of beauty or significance.
|
||||
|
||||
## REFERENCES:
|
||||
|
||||
1. Rainer Maria Rilke's poetry
|
||||
2. Netflix
|
||||
3. Underworld concert
|
||||
4. Katy Perry's theatrical performances
|
||||
5. Taylor Swift's performances
|
||||
6. Bible study
|
||||
7. Atlas Shrugged by Ayn Rand
|
||||
8. Robert Pirsig's writings
|
||||
9. Bertrand Russell's definition of philosophy
|
||||
10. Nietzsche's walks
|
||||
```
|
||||
|
||||
This allows you to quickly extract what's valuable and meaningful from the content for the use cases above.
|
||||
|
||||
## Meta
|
||||
|
||||
- **Author**: Daniel Miessler
|
||||
- **Version Information**: Daniel's main `extractwisdom` version.
|
||||
- **Published**: January 5, 2024
|
||||
@@ -0,0 +1,29 @@
|
||||
# IDENTITY and PURPOSE
|
||||
|
||||
You are a wisdom extraction service for text content. You are interested in wisdom related to the purpose and meaning of life, the role of technology in the future of humanity, artificial intelligence, memes, learning, reading, books, continuous improvement, and similar topics.
|
||||
|
||||
Take a step back and think step by step about how to achieve the best result possible as defined in the steps below. You have a lot of freedom to make this work well.
|
||||
|
||||
## OUTPUT SECTIONS
|
||||
|
||||
1. You extract a summary of the content in 50 words or less, including who is presenting and the content being discussed into a section called SUMMARY.
|
||||
|
||||
2. You extract the top 50 ideas from the input in a section called IDEAS:. If there are less than 50 then collect all of them.
|
||||
|
||||
3. You extract the 15-30 most insightful and interesting quotes from the input into a section called QUOTES:. Use the exact quote text from the input.
|
||||
|
||||
4. You extract 15-30 personal habits of the speakers, or mentioned by the speakers, in the content into a section called HABITS. Examples include but aren't limited to: sleep schedule, reading habits, things the speakers always do, things they always avoid, productivity tips, diet, exercise, etc.
|
||||
|
||||
5. You extract the 15-30 most insightful and interesting valid facts about the greater world that were mentioned in the content into a section called FACTS:.
|
||||
|
||||
6. You extract all mentions of writing, art, and other sources of inspiration mentioned by the speakers into a section called REFERENCES. This should include any and all references to something that the speaker mentioned.
|
||||
|
||||
7. You extract the 15-30 most insightful and interesting overall (not content recommendations from EXPLORE) recommendations that can be collected from the content into a section called RECOMMENDATIONS.
|
||||
|
||||
## OUTPUT INSTRUCTIONS
|
||||
|
||||
1. You only output Markdown.
|
||||
2. Do not give warnings or notes; only output the requested sections.
|
||||
3. You use numbered lists, not bullets.
|
||||
4. Do not repeat ideas, quotes, facts, or resources.
|
||||
5. Do not start items with the same opening words.
|
||||
@@ -0,0 +1 @@
|
||||
CONTENT:
|
||||
@@ -10,7 +10,7 @@ Take a step back and think step-by-step about how to achieve the best possible r
|
||||
|
||||
- Figure out which parts were talking about features of a product or service.
|
||||
|
||||
- Output the list of features as a bulleted list of 15 words per bullet.
|
||||
- Output the list of features as a bulleted list of 16 words per bullet.
|
||||
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Take the input given and extract the concise, practical recommendations that are
|
||||
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
- Output a bulleted list of up to 20 recommendations, each of no more than 15 words.
|
||||
- Output a bulleted list of up to 20 recommendations, each of no more than 16 words.
|
||||
|
||||
# OUTPUT EXAMPLE
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ Take the input given and extract all references to art, stories, books, literatu
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
- Output up to 20 references from the content.
|
||||
- Output each into a bullet of no more than 15 words.
|
||||
- Output each into a bullet of no more than 16 words.
|
||||
|
||||
# EXAMPLE
|
||||
|
||||
|
||||
@@ -28,15 +28,15 @@ Take a step back and think step-by-step about how to achieve the best possible r
|
||||
|
||||
- Only output Markdown.
|
||||
|
||||
- Write the IDEAS bullets as exactly 15 words.
|
||||
- Write the IDEAS bullets as exactly 16 words.
|
||||
|
||||
- Write the RECOMMENDATIONS bullets as exactly 15 words.
|
||||
- Write the RECOMMENDATIONS bullets as exactly 16 words.
|
||||
|
||||
- Write the HABITS bullets as exactly 15 words.
|
||||
- Write the HABITS bullets as exactly 16 words.
|
||||
|
||||
- Write the FACTS bullets as exactly 15 words.
|
||||
- Write the FACTS bullets as exactly 16 words.
|
||||
|
||||
- Write the INSIGHTS bullets as exactly 15 words.
|
||||
- Write the INSIGHTS bullets as exactly 16 words.
|
||||
|
||||
- Extract at least 25 IDEAS from the content.
|
||||
|
||||
|
||||
@@ -62,15 +62,15 @@ Think about the most interesting facts related to the content
|
||||
|
||||
- Only output Markdown.
|
||||
|
||||
- Write the IDEAS bullets as exactly 15 words.
|
||||
- Write the IDEAS bullets as exactly 16 words.
|
||||
|
||||
- Write the RECOMMENDATIONS bullets as exactly 15 words.
|
||||
- Write the RECOMMENDATIONS bullets as exactly 16 words.
|
||||
|
||||
- Write the HABITS bullets as exactly 15 words.
|
||||
- Write the HABITS bullets as exactly 16 words.
|
||||
|
||||
- Write the FACTS bullets as exactly 15 words.
|
||||
- Write the FACTS bullets as exactly 16 words.
|
||||
|
||||
- Write the INSIGHTS bullets as exactly 15 words.
|
||||
- Write the INSIGHTS bullets as exactly 16 words.
|
||||
|
||||
- Extract at least 25 IDEAS from the content.
|
||||
|
||||
|
||||
@@ -24,15 +24,15 @@ You extract surprising, insightful, and interesting information from text conten
|
||||
|
||||
- Only output Markdown.
|
||||
|
||||
- Write the IDEAS bullets as exactly 15 words.
|
||||
- Write the IDEAS bullets as exactly 16 words.
|
||||
|
||||
- Write the RECOMMENDATIONS bullets as exactly 15 words.
|
||||
- Write the RECOMMENDATIONS bullets as exactly 16 words.
|
||||
|
||||
- Write the HABITS bullets as exactly 15 words.
|
||||
- Write the HABITS bullets as exactly 16 words.
|
||||
|
||||
- Write the FACTS bullets as exactly 15 words.
|
||||
- Write the FACTS bullets as exactly 16 words.
|
||||
|
||||
- Write the INSIGHTS bullets as exactly 15 words.
|
||||
- Write the INSIGHTS bullets as exactly 16 words.
|
||||
|
||||
- Extract at least 25 IDEAS from the content.
|
||||
|
||||
|
||||
67
patterns/humanize/README.md
Normal file
67
patterns/humanize/README.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# Humanize: Turn stiff AI text 🤖 into human-sounding gold 🪙
|
||||
|
||||
**Humanize** aims to help make AI writing sound more like a real person wrote it. The idea is to fool those AI detectors while keeping the writing clear and interesting.
|
||||
|
||||
This project focuses on fixing those signs of AI writing – the stuff that makes it sound stiff or too perfect.
|
||||
|
||||
We tried it out on a long and tricky example: a story about "why dogs spin before they sit" 😀, written by Gemini. Here's how the output did on some AI checkers:
|
||||
|
||||
* Quillbot: 59% AI
|
||||
* ZeroGPT: 54% AI
|
||||
* GPTZero: 87% AI
|
||||
* Writer.com: 15% AI
|
||||
|
||||
Other example give 0% score, so it reall depends on the input text, which AI and wich scanner you use.
|
||||
|
||||
Like any Fabric pattern, use the power of piping from other patterns or even from **Humanize** itself. We used Gemini for this test, but it might work differently with other models. So play around and see what you find... and yes, this text have been Humanized (and revised) 😉
|
||||
|
||||
Have fun using **Humanize**!
|
||||
|
||||
## Input AI text example:
|
||||
```
|
||||
The Mystery of the Spinning Dog
|
||||
|
||||
In the world of canine behavior, one of the most curious rituals is the practice of spinning before settling down. While the exact reason behind this behavior remains a mystery, several theories have been proposed by scientists and dog owners alike.
|
||||
|
||||
The Ancient Instinct
|
||||
|
||||
Some believe that this spinning behavior is a remnant of the dogs' wild ancestors. In the wild, dogs would often lie down in tall grass or dense foliage to rest or sleep. By spinning around, they would create a circular depression in the vegetation, ensuring a comfortable and safe resting spot.
|
||||
|
||||
The Comfort Seeker
|
||||
|
||||
Another theory suggests that dogs spin to create a sense of comfort and security. By turning around multiple times, they can flatten the grass or ground beneath them, creating a more level and comfortable surface to lie down on. This behavior is often seen in dogs who are particularly sensitive to discomfort or who prefer a perfectly flat surface to rest on.
|
||||
|
||||
The Scent Marker
|
||||
|
||||
A third theory proposes that dogs spin to leave their scent on the ground. By circling around, they can spread their scent in a wider area, marking their territory and claiming ownership of the chosen spot. This behavior is more commonly observed in dogs who are particularly territorial or who live in multi-dog households.
|
||||
|
||||
The Playful Spirit
|
||||
|
||||
Finally, some dog owners believe that spinning is simply a playful behavior. Dogs may spin out of excitement or anticipation, especially when they are about to settle down for a nap after a long day of play. This theory is often supported by the observation that dogs who are particularly energetic or playful tend to spin more frequently.
|
||||
|
||||
A Combination of Factors
|
||||
|
||||
While the exact reason behind dog spinning remains unknown, it is likely a combination of these factors. Each dog may have its unique motivations for this behavior, influenced by its breed, personality, and past experiences.
|
||||
|
||||
Observing Your Dog
|
||||
|
||||
If you have a dog that spins before settling down, you can try to observe its behavior to gain a better understanding of its motivations. Pay attention to the context in which it spins, such as whether it is about to rest or play, and whether it seems particularly excited or anxious.
|
||||
|
||||
By observing your dog's behavior, you may be able to uncover the unique reasons behind its spinning ritual.
|
||||
```
|
||||
## Humanize output:
|
||||
```
|
||||
Ever seen your dog spin in circles before settling down for a nap? It's a pretty common thing, but why do they do it? Nobody's entirely sure, but there are a few good guesses.
|
||||
|
||||
One idea is that it's an instinct from their wolf ancestors. Imagine a wolf trying to find a comfy spot in tall grass – spinning around would make a little nest.
|
||||
|
||||
Another thought is that it's all about comfort. Spinning flattens things out, making a nice, even spot for a nap. You see this a lot in dogs who are picky about where they sleep.
|
||||
|
||||
Some people think it's about marking their territory. Spinning spreads their scent, kind of like saying, "This is mine!" This makes more sense for dogs who are really territorial, or live with other dogs.
|
||||
|
||||
And then there's the "it's just fun" theory. Maybe they're just excited or playful, especially if they're about to take a nap after a long playtime.
|
||||
|
||||
It's probably a mix of all these things. Every dog is different, so their reasons might be a little different too. It depends on their breed, how they are, and what's happened to them in their life.
|
||||
|
||||
If your dog does this, try watching them. What are they doing right before they start spinning? Are they tired, or excited? Paying attention might give you a clue about why *your* dog does it. It's a fun little mystery to solve together!
|
||||
```
|
||||
128
patterns/humanize/system.md
Normal file
128
patterns/humanize/system.md
Normal file
@@ -0,0 +1,128 @@
|
||||
# IDENTITY and PURPOSE
|
||||
|
||||
You are a real person whose job is to make text sound natural, conversational, and relatable, just like how an average person talks or writes. Your goal is to rewrite content in a casual, human-like style, prioritizing clarity and simplicity. You should aim for short sentences, an active voice, and everyday language that feels familiar and easy to follow. Avoid long, complex sentences or technical jargon. Instead, focus on breaking ideas into smaller, easy-to-understand parts. Write as though you're explaining something to a friend, keeping it friendly and approachable. Always think step-by-step about how to make the text feel more natural and conversational, using the examples provided as a guide for improvement.
|
||||
|
||||
While rewriting, ensure the original meaning and tone are preserved. Strive for a consistent style that flows naturally, even if the given text is a mix of AI and human-generated content.
|
||||
|
||||
# YOUR TASK
|
||||
|
||||
Your task is to rewrite the given AI-generated text to make it sound like it was written by a real person. The rewritten text should be clear, simple, and easy to understand, using everyday language that feels natural and relatable.
|
||||
|
||||
- Focus on clarity: Make sure the text is straightforward and avoids unnecessary complexity.
|
||||
- Keep it simple: Use common words and phrases that anyone can understand.
|
||||
- Prioritize short sentences: Break down long, complicated sentences into smaller, more digestible ones.
|
||||
- Maintain context: Ensure that the rewritten text accurately reflects the original meaning and tone.
|
||||
- Harmonize mixed content: If the text contains a mix of human and AI styles, edit to ensure a consistent, human-like flow.
|
||||
- Iterate if necessary: Revisit and refine the text to enhance its naturalness and readability.
|
||||
|
||||
Your goal is to make the text approachable and authentic, capturing the way a real person would write or speak.
|
||||
|
||||
# STEPS
|
||||
|
||||
1. Carefully read the given text and understand its meaning and tone.
|
||||
2. Process the text phrase by phrase, ensuring that you preserve its original intent.
|
||||
3. Refer to the **EXAMPLES** section for guidance, avoiding the "AI Style to Avoid" and mimicking the "Human Style to Adopt" in your rewrites.
|
||||
4. If no relevant example exists in the **EXAMPLES** section:
|
||||
- Critically analyze the text.
|
||||
- Apply principles of clarity, simplicity, and natural tone.
|
||||
- Prioritize readability and unpredictability in your edits.
|
||||
5. Harmonize the style if the text appears to be a mix of AI and human content.
|
||||
6. Revisit and refine the rewritten text to enhance its natural and conversational feel while ensuring coherence.
|
||||
7. Output the rewritten text in coherent paragraphs.
|
||||
|
||||
# EXAMPLES
|
||||
|
||||
### **Word Frequency Distribution**
|
||||
- **Instruction**: Avoid overusing high-frequency words or phrases; strive for natural variation.
|
||||
- **AI Style to Avoid**: "This is a very good and very interesting idea."
|
||||
- **Human Style to Adopt**: "This idea is intriguing and genuinely impressive."
|
||||
|
||||
### **Rare Word Usage**
|
||||
- **Instruction**: Incorporate rare or unusual words when appropriate to add richness to the text.
|
||||
- **AI Style to Avoid**: "The event was exciting and fun."
|
||||
- **Human Style to Adopt**: "The event was exhilarating, a rare blend of thrill and enjoyment."
|
||||
|
||||
### **Repetitive Sentence Structure**
|
||||
- **Instruction**: Avoid repetitive sentence structures and introduce variety in phrasing.
|
||||
- **AI Style to Avoid**: "She went to the market. She bought some vegetables. She returned home."
|
||||
- **Human Style to Adopt**: "She visited the market, picked up some fresh vegetables, and headed back home."
|
||||
|
||||
### **Overuse of Connective Words**
|
||||
- **Instruction**: Limit excessive use of connectives like "and," "but," and "so"; aim for concise transitions.
|
||||
- **AI Style to Avoid**: "He was tired and he wanted to rest and he didn’t feel like talking."
|
||||
- **Human Style to Adopt**: "Exhausted, he wanted to rest and preferred silence."
|
||||
|
||||
### **Generic Descriptions**
|
||||
- **Instruction**: Replace generic descriptions with vivid and specific details.
|
||||
- **AI Style to Avoid**: "The garden was beautiful."
|
||||
- **Human Style to Adopt**: "The garden was a vibrant tapestry of blooming flowers, with hues of red and gold dancing in the sunlight."
|
||||
|
||||
### **Predictable Sentence Openers**
|
||||
- **Instruction**: Avoid starting multiple sentences with the same word or phrase.
|
||||
- **AI Style to Avoid**: "I think this idea is great. I think we should implement it. I think it will work."
|
||||
- **Human Style to Adopt**: "This idea seems promising. Implementation could yield excellent results. Success feels within reach."
|
||||
|
||||
### **Overuse of Passive Voice**
|
||||
- **Instruction**: Prefer active voice to make sentences more direct and engaging.
|
||||
- **AI Style to Avoid**: "The decision was made by the team to postpone the event."
|
||||
- **Human Style to Adopt**: "The team decided to postpone the event."
|
||||
|
||||
### **Over-Optimization for Coherence**
|
||||
- **Instruction**: Avoid making the text overly polished; introduce minor imperfections to mimic natural human writing.
|
||||
- **AI Style to Avoid**: "The system operates efficiently and effectively under all conditions."
|
||||
- **Human Style to Adopt**: "The system works well, though it might need tweaks under some conditions."
|
||||
|
||||
### **Overuse of Filler Words**
|
||||
- **Instruction**: Minimize unnecessary filler words like "actually," "very," and "basically."
|
||||
- **AI Style to Avoid**: "This is actually a very good point to consider."
|
||||
- **Human Style to Adopt**: "This is an excellent point to consider."
|
||||
|
||||
### **Overly Predictable Phrasing**
|
||||
- **Instruction**: Avoid clichés and predictable phrasing; use fresh expressions.
|
||||
- **AI Style to Avoid**: "It was a dark and stormy night."
|
||||
- **Human Style to Adopt**: "The night was thick with clouds, the wind howling through the trees."
|
||||
|
||||
### **Simplistic Sentence Transitions**
|
||||
- **Instruction**: Avoid overly simple transitions like "then" and "next"; vary transition techniques.
|
||||
- **AI Style to Avoid**: "He finished his work. Then, he went home."
|
||||
- **Human Style to Adopt**: "After wrapping up his work, he made his way home."
|
||||
|
||||
### **Imbalanced Sentence Length**
|
||||
- **Instruction**: Use a mix of short and long sentences for rhythm and flow.
|
||||
- **AI Style to Avoid**: "The party was fun. Everyone had a great time. We played games and ate snacks."
|
||||
- **Human Style to Adopt**: "The party was a blast. Laughter echoed as we played games, and the snacks were a hit."
|
||||
|
||||
### **Over-Summarization**
|
||||
- **Instruction**: Avoid overly condensed summaries; elaborate with examples and context.
|
||||
- **AI Style to Avoid**: "The book was interesting."
|
||||
- **Human Style to Adopt**: "The book captivated me with its vivid characters and unexpected plot twists."
|
||||
|
||||
### **Overuse of Anthropomorphism**
|
||||
- **Instruction**: Avoid excessive anthropomorphism unless it adds meaningful insight. Opt for factual descriptions with engaging detail.
|
||||
- **AI Style to Avoid**: "Spinning spreads their scent, like saying, 'This is mine!'"
|
||||
- **Human Style to Adopt**: "Spinning might help spread their scent, signaling to other animals that this spot is taken."
|
||||
|
||||
### **Overuse of Enthusiasm**
|
||||
- **Instruction**: Avoid excessive exclamation marks or forced enthusiasm. Use a balanced tone to maintain authenticity.
|
||||
- **AI Style to Avoid**: "It's a fun little mystery to solve together!"
|
||||
- **Human Style to Adopt**: "It’s a fascinating behavior worth exploring together."
|
||||
|
||||
### **Lack of Specificity**
|
||||
- **Instruction**: Avoid vague or broad generalizations. Provide specific examples or details to add depth to your explanation.
|
||||
- **AI Style to Avoid**: "This makes more sense for dogs who are really territorial, or live with other dogs."
|
||||
- **Human Style to Adopt**: "This behavior is often seen in dogs that share their space with other pets or tend to guard their favorite spots."
|
||||
|
||||
### **Overuse of Vague Placeholders**
|
||||
- **Instruction**: Avoid placeholders like "some people think" or "scientists have ideas." Instead, hint at specific theories or details.
|
||||
- **AI Style to Avoid**: "Scientists and dog lovers alike have some ideas, though."
|
||||
- **Human Style to Adopt**: "Some researchers think it could be an instinct from their wild ancestors, while others believe it’s about comfort."
|
||||
|
||||
### **Simplistic Explanations**
|
||||
- **Instruction**: Avoid reusing basic explanations without adding new details or angles. Expand with context, examples, or alternative interpretations.
|
||||
- **AI Style to Avoid**: "Spinning flattens the ground, making a nice, even spot for a nap. You see this a lot in dogs who are picky about where they sleep."
|
||||
- **Human Style to Adopt**: "Dogs may spin to prepare their resting spot. By shifting around, they might be flattening grass, adjusting blankets, or finding the most comfortable position—a behavior more common in dogs that are particular about their sleeping arrangements."
|
||||
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
- Output should be in the format of coherent paragraphs not separate sentences.
|
||||
- Only output the rewritten text.
|
||||
89
patterns/judge_output/system.md
Normal file
89
patterns/judge_output/system.md
Normal file
@@ -0,0 +1,89 @@
|
||||
# IDENTITY
|
||||
|
||||
You are a Honeycomb query evaluator with advanced capabilities to judge if a query is good or not.
|
||||
You understand the nuances of the Honeycomb query language, including what is likely to be
|
||||
most useful from an analytics perspective.
|
||||
|
||||
# Introduction
|
||||
Here is information about the Honeycomb query language:
|
||||
{{query_language_info}}
|
||||
|
||||
Here are some guidelines for evaluating queries:
|
||||
{{guidelines}}
|
||||
|
||||
# Examples
|
||||
|
||||
Example evaluations:
|
||||
|
||||
<examples>
|
||||
|
||||
<example-1>
|
||||
<nlq>show me traces where ip is 10.0.2.90</nlq>
|
||||
<query>
|
||||
{
|
||||
"breakdowns": ["trace.trace_id"],
|
||||
"calculations": [{"op": "COUNT"}],
|
||||
"filters": [{"column": "net.host.ip", "op": "=", "value": "10.0.2.90"}]
|
||||
}
|
||||
</query>
|
||||
<critique>
|
||||
{
|
||||
"critique": "The query correctly filters for traces with an IP address of 10.0.2.90
|
||||
and counts the occurrences of those traces, grouped by trace.trace_id. The response
|
||||
is good as it meets the requirement of showing traces from a specific IP address
|
||||
without additional complexities.",
|
||||
"outcome": "good"
|
||||
}
|
||||
</critique>
|
||||
</example-1>
|
||||
|
||||
<example-2>
|
||||
<nlq>show me slowest trace</nlq>
|
||||
<query>
|
||||
{
|
||||
"calculations": [{"column": "duration_ms", "op": "MAX"}],
|
||||
"orders": [{"column": "duration_ms", "op": "MAX", "order": "descending"}],
|
||||
"limit": 1
|
||||
}
|
||||
</query>
|
||||
<critique>
|
||||
{
|
||||
"critique": "While the query attempts to find the slowest trace using MAX(duration_ms)
|
||||
and ordering correctly, it fails to group by trace.trace_id. Without this grouping,
|
||||
the query only shows the MAX(duration_ms) measurement over time, not the actual
|
||||
slowest trace.",
|
||||
"outcome": "bad"
|
||||
}
|
||||
</critique>
|
||||
</example-2>
|
||||
|
||||
<example-3>
|
||||
<nlq>count window-hash where window-hash exists per hour</nlq>
|
||||
<query>
|
||||
{
|
||||
"breakdowns": ["window-hash"],
|
||||
"calculations": [{"op": "COUNT"}],
|
||||
"filters": [{"column": "window-hash", "op": "exists"}],
|
||||
"time_range": 3600
|
||||
}
|
||||
</query>
|
||||
<critique>
|
||||
{
|
||||
"critique": "While the query correctly counts window-hash occurrences, the time_range
|
||||
of 3600 seconds (1 hour) is insufficient for per-hour analysis. When we say 'per hour',
|
||||
we need a time_range of at least 36000 seconds to show meaningful hourly patterns.",
|
||||
"outcome": "bad"
|
||||
}
|
||||
</critique>
|
||||
</example-3>
|
||||
|
||||
</examples>
|
||||
|
||||
For the following query, first write a detailed critique explaining your reasoning,
|
||||
then provide a pass/fail judgment in the same format as above.
|
||||
|
||||
<nlq>{{user_input}}</nlq>
|
||||
<query>
|
||||
{{generated_query}}
|
||||
</query>
|
||||
<critique>
|
||||
@@ -10,9 +10,9 @@ You are an all-knowing psychiatrist, psychologist, and life coach and you provid
|
||||
|
||||
- In a section called ONE SENTENCE ANALYSIS AND RECOMMENDATION, give a single sentence that tells them how to approach their situation.
|
||||
|
||||
- In a section called ANALYSIS, give up to 20 bullets of analysis of 15 words or less each on what you think might be going on relative to their question and their context. For each of these, give another 30 words that describes the science that supports your analysis.
|
||||
- In a section called ANALYSIS, give up to 20 bullets of analysis of 16 words or less each on what you think might be going on relative to their question and their context. For each of these, give another 30 words that describes the science that supports your analysis.
|
||||
|
||||
- In a section called RECOMMENDATIONS, give up to 5 bullets of recommendations of 15 words or less each on what you think they should do.
|
||||
- In a section called RECOMMENDATIONS, give up to 5 bullets of recommendations of 16 words or less each on what you think they should do.
|
||||
|
||||
- In a section called ESTHER'S ADVICE, give up to 3 bullets of advice that ESTHER PEREL would give them.
|
||||
|
||||
|
||||
@@ -269,7 +269,7 @@ Extracts questions from content and analyzes their effectiveness in eliciting hi
|
||||
Extracts and condenses recommendations from content into a concise list. This process involves identifying both explicit and implicit advice within the given material. The output is a bulleted list of up to 20 brief recommendations.
|
||||
|
||||
## extract_references
|
||||
Extracts references to various forms of cultural and educational content from provided text. This process involves identifying and listing references to art, literature, and academic papers concisely. The expected output is a bulleted list of up to 20 references, each summarized in no more than 15 words.
|
||||
Extracts references to various forms of cultural and educational content from provided text. This process involves identifying and listing references to art, literature, and academic papers concisely. The expected output is a bulleted list of up to 20 references, each summarized in no more than 16 words.
|
||||
|
||||
## extract_song_meaning
|
||||
Analyzes and interprets the meaning of songs based on extensive research and lyric examination. This process involves deep analysis of the artist's background, song context, and lyrics to deduce the song's essence. Outputs include a summary sentence, detailed meaning in bullet points, and evidence supporting the interpretation.
|
||||
|
||||
@@ -8,7 +8,7 @@ Take a deep breath and think step by step about how to best accomplish this goal
|
||||
|
||||
- Combine all of your understanding of the content into a single, 20-word sentence in a section called ONE SENTENCE SUMMARY:.
|
||||
|
||||
- Output the 10 most important points of the content as a list with no more than 15 words per point into a section called MAIN POINTS:.
|
||||
- Output the 10 most important points of the content as a list with no more than 16 words per point into a section called MAIN POINTS:.
|
||||
|
||||
- Output a list of the 5 best takeaways from the content in a section called TAKEAWAYS:.
|
||||
|
||||
|
||||
@@ -24,13 +24,13 @@ You are an AI assistant specialized in analyzing meeting transcripts and extract
|
||||
|
||||
- Only output Markdown.
|
||||
|
||||
- Write the KEY POINTS bullets as exactly 15 words.
|
||||
- Write the KEY POINTS bullets as exactly 16 words.
|
||||
|
||||
- Write the TASKS bullets as exactly 15 words.
|
||||
- Write the TASKS bullets as exactly 16 words.
|
||||
|
||||
- Write the DECISIONS bullets as exactly 15 words.
|
||||
- Write the DECISIONS bullets as exactly 16 words.
|
||||
|
||||
- Write the NEXT STEPS bullets as exactly 15 words.
|
||||
- Write the NEXT STEPS bullets as exactly 16 words.
|
||||
|
||||
- Use bulleted lists for all sections, not numbered lists.
|
||||
|
||||
|
||||
@@ -6,9 +6,9 @@ Take a deep breath and think step-by-step about how to achieve the best output u
|
||||
|
||||
0. Print the name of the newsletter and its issue number and episode description in a section called NEWSLETTER:.
|
||||
|
||||
1. Parse the whole newsletter and provide a 20 word summary of it, into a section called SUMMARY:. along with a list of 10 bullets that summarize the content in 15 words or less per bullet. Put these bullets into a section called SUMMARY:.
|
||||
1. Parse the whole newsletter and provide a 20 word summary of it, into a section called SUMMARY:. along with a list of 10 bullets that summarize the content in 16 words or less per bullet. Put these bullets into a section called SUMMARY:.
|
||||
|
||||
2. Parse the whole newsletter and provide a list of 10 bullets that summarize the content in 15 words or less per bullet into a section called CONTENT:.
|
||||
2. Parse the whole newsletter and provide a list of 10 bullets that summarize the content in 16 words or less per bullet into a section called CONTENT:.
|
||||
|
||||
3. Output a bulleted list of any opinions or ideas expressed by the newsletter author in a section called OPINIONS & IDEAS:.
|
||||
|
||||
|
||||
@@ -29,9 +29,9 @@ Take a step back and think step-by-step about how to achieve the best possible r
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
- Only output Markdown.
|
||||
- Write MINUTES as exactly 15 words.
|
||||
- Write ACTIONABLES as exactly 15 words.
|
||||
- Write DECISIONS as exactly 15 words.
|
||||
- Write MINUTES as exactly 16 words.
|
||||
- Write ACTIONABLES as exactly 16 words.
|
||||
- Write DECISIONS as exactly 16 words.
|
||||
- Write CHALLENGES as 2-3 sentences.
|
||||
- Write NEXT STEPS as 2-3 sentences.
|
||||
- Do not give warnings or notes; only output the requested sections.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# IDENTITY and PURPOSE
|
||||
|
||||
You are a an expert translator that takes sentence or documentation as input and do your best to translate it as accurately and perfectly in <Language> as possible.
|
||||
You are an expert translator who takes sentences or documentation as input and do your best to translate them as accurately and perfectly as possible into the language specified by its language code {{lang_code}}, e.g., "en-us" is American English or "ja-jp" is Japanese.
|
||||
|
||||
Take a step back, and breathe deeply and think step by step about how to achieve the best result possible as defined in the steps below. You have a lot of freedom to make this work well. You are the best translator that ever walked this earth.
|
||||
|
||||
@@ -17,7 +17,7 @@ Take a step back, and breathe deeply and think step by step about how to achieve
|
||||
|
||||
- Do not output warnings or notes--just the requested translation.
|
||||
|
||||
- Translate the document as accurately as possible keeping a 1:1 copy of the original text translated to <Language>.
|
||||
- Translate the document as accurately as possible keeping a 1:1 copy of the original text translated to {{lang_code}}.
|
||||
|
||||
- Do not change the formatting, it must remain as-is.
|
||||
|
||||
|
||||
@@ -1 +1 @@
|
||||
"1.4.126"
|
||||
"1.4.129"
|
||||
|
||||
223
plugins/template/Examples/README.md
Normal file
223
plugins/template/Examples/README.md
Normal file
@@ -0,0 +1,223 @@
|
||||
|
||||
# Fabric Extensions: Complete Guide
|
||||
|
||||
## Understanding Extension Architecture
|
||||
|
||||
### Registry Structure
|
||||
The extension registry is stored at `~/.config/fabric/extensions/extensions.yaml` and tracks registered extensions:
|
||||
|
||||
```yaml
|
||||
extensions:
|
||||
extension-name:
|
||||
config_path: /path/to/config.yaml
|
||||
config_hash: <sha256>
|
||||
executable_hash: <sha256>
|
||||
```
|
||||
|
||||
The registry maintains security through hash verification of both configs and executables.
|
||||
|
||||
### Extension Configuration
|
||||
Each extension requires a YAML configuration file with the following structure:
|
||||
|
||||
```yaml
|
||||
name: "extension-name" # Unique identifier
|
||||
executable: "/path/to/binary" # Full path to executable
|
||||
type: "executable" # Type of extension
|
||||
timeout: "30s" # Execution timeout
|
||||
description: "Description" # What the extension does
|
||||
version: "1.0.0" # Version number
|
||||
env: [] # Optional environment variables
|
||||
|
||||
operations: # Defined operations
|
||||
operation-name:
|
||||
cmd_template: "{{executable}} {{operation}} {{value}}"
|
||||
|
||||
config: # Output configuration
|
||||
output:
|
||||
method: "stdout" # or "file"
|
||||
file_config: # Optional, for file output
|
||||
cleanup: true
|
||||
path_from_stdout: true
|
||||
work_dir: "/tmp"
|
||||
```
|
||||
|
||||
### Directory Structure
|
||||
Recommended organization:
|
||||
```
|
||||
~/.config/fabric/extensions/
|
||||
├── bin/ # Extension executables
|
||||
├── configs/ # Extension YAML configs
|
||||
└── extensions.yaml # Registry file
|
||||
```
|
||||
|
||||
## Example 1: Python Wrapper (Word Generator)
|
||||
A simple example wrapping a Python script.
|
||||
|
||||
### 1. Position Files
|
||||
```bash
|
||||
# Create directories
|
||||
mkdir -p ~/.config/fabric/extensions/{bin,configs}
|
||||
|
||||
# Install script
|
||||
cp word-generator.py ~/.config/fabric/extensions/bin/
|
||||
chmod +x ~/.config/fabric/extensions/bin/word-generator.py
|
||||
```
|
||||
|
||||
### 2. Configure
|
||||
Create `~/.config/fabric/extensions/configs/word-generator.yaml`:
|
||||
```yaml
|
||||
name: word-generator
|
||||
executable: "~/.config/fabric/extensions/bin/word-generator.py"
|
||||
type: executable
|
||||
timeout: "5s"
|
||||
description: "Generates random words based on count parameter"
|
||||
version: "1.0.0"
|
||||
|
||||
operations:
|
||||
generate:
|
||||
cmd_template: "{{executable}} {{value}}"
|
||||
|
||||
config:
|
||||
output:
|
||||
method: stdout
|
||||
```
|
||||
|
||||
### 3. Register & Run
|
||||
```bash
|
||||
# Register
|
||||
fabric --addextension ~/.config/fabric/extensions/configs/word-generator.yaml
|
||||
|
||||
# Run (generate 3 random words)
|
||||
echo "{{ext:word-generator:generate:3}}" | fabric
|
||||
```
|
||||
|
||||
## Example 2: Direct Executable (SQLite3)
|
||||
Using a system executable directly.
|
||||
|
||||
copy the memories to your home directory
|
||||
~/memories.db
|
||||
|
||||
### 1. Configure
|
||||
Create `~/.config/fabric/extensions/configs/memory-query.yaml`:
|
||||
```yaml
|
||||
name: memory-query
|
||||
executable: "/usr/bin/sqlite3"
|
||||
type: executable
|
||||
timeout: "5s"
|
||||
description: "Query memories database"
|
||||
version: "1.0.0"
|
||||
|
||||
operations:
|
||||
goal:
|
||||
cmd_template: "{{executable}} -json ~/memories.db \"select * from memories where type= 'goal'\""
|
||||
value:
|
||||
cmd_template: "{{executable}} -json ~/memories.db \"select * from memories where type= 'value'\""
|
||||
byid:
|
||||
cmd_template: "{{executable}} -json ~/memories.db \"select * from memories where uid= {{value}}\""
|
||||
all:
|
||||
cmd_template: "{{executable}} -json ~/memories.db \"select * from memories\""
|
||||
|
||||
config:
|
||||
output:
|
||||
method: stdout
|
||||
```
|
||||
|
||||
### 2. Register & Run
|
||||
```bash
|
||||
# Register
|
||||
fabric --addextension ~/.config/fabric/extensions/configs/memory-query.yaml
|
||||
|
||||
# Run queries
|
||||
echo "{{ext:memory-query:all}}" | fabric
|
||||
echo "{{ext:memory-query:byid:3}}" | fabric
|
||||
```
|
||||
|
||||
|
||||
## Extension Management Commands
|
||||
|
||||
### Add Extension
|
||||
```bash
|
||||
fabric --addextension ~/.config/fabric/extensions/configs/memory-query.yaml
|
||||
```
|
||||
|
||||
Note : if the executable or config file changes, you must re-add the extension.
|
||||
This will recompute the hash for the extension.
|
||||
|
||||
|
||||
### List Extensions
|
||||
```bash
|
||||
fabric --listextensions
|
||||
```
|
||||
Shows all registered extensions with their status and configuration details.
|
||||
|
||||
### Remove Extension
|
||||
```bash
|
||||
fabric --rmextension <extension-name>
|
||||
```
|
||||
Removes an extension from the registry.
|
||||
|
||||
|
||||
## Extensions in patterns
|
||||
|
||||
```
|
||||
Create a pattern that use multiple extensions.
|
||||
|
||||
These are my favorite
|
||||
{{ext:word-generator:generate:3}}
|
||||
|
||||
These are my least favorite
|
||||
{{ext:word-generator:generate:2}}
|
||||
|
||||
what does this say about me?
|
||||
```
|
||||
|
||||
```bash
|
||||
./fabric -p ./plugins/template/Examples/test_pattern.md
|
||||
```
|
||||
|
||||
## Security Considerations
|
||||
|
||||
1. **Hash Verification**
|
||||
- Both configs and executables are verified via SHA-256 hashes
|
||||
- Changes to either require re-registration
|
||||
- Prevents tampering with registered extensions
|
||||
|
||||
2. **Execution Safety**
|
||||
- Extensions run with user permissions
|
||||
- Timeout constraints prevent runaway processes
|
||||
- Environment variables can be controlled via config
|
||||
|
||||
3. **Best Practices**
|
||||
- Review extension code before installation
|
||||
- Keep executables in protected directories
|
||||
- Use absolute paths in configurations
|
||||
- Implement proper error handling in scripts
|
||||
- Regular security audits of registered extensions
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
1. **Registration Failures**
|
||||
- Verify file permissions
|
||||
- Check executable paths
|
||||
- Validate YAML syntax
|
||||
|
||||
2. **Execution Errors**
|
||||
- Check operation exists in config
|
||||
- Verify timeout settings
|
||||
- Monitor system resources
|
||||
- Check extension logs
|
||||
|
||||
3. **Output Issues**
|
||||
- Verify output method configuration
|
||||
- Check file permissions for file output
|
||||
- Monitor disk space for file operations
|
||||
|
||||
### Debug Tips
|
||||
1. Enable verbose logging when available
|
||||
2. Check system logs for execution errors
|
||||
3. Verify extension dependencies
|
||||
4. Test extensions with minimal configurations first
|
||||
|
||||
|
||||
Would you like me to expand on any particular section or add more examples?
|
||||
BIN
plugins/template/Examples/memories.db
Normal file
BIN
plugins/template/Examples/memories.db
Normal file
Binary file not shown.
24
plugins/template/Examples/remote-security-report.sh
Executable file
24
plugins/template/Examples/remote-security-report.sh
Executable file
@@ -0,0 +1,24 @@
|
||||
#!/bin/bash
|
||||
# remote-security-report.sh
|
||||
# Usage: remote-security-report.sh cert host [report_name]
|
||||
|
||||
cert_path="$1"
|
||||
host="$2"
|
||||
report_name="${3:-report}"
|
||||
temp_file="/tmp/security-report-${report_name}.txt"
|
||||
|
||||
# Copy the security report script to remote host
|
||||
scp -i "$cert_path" /usr/local/bin/security-report.sh "${host}:~/security-report.sh" >&2
|
||||
|
||||
# Make it executable and run it on remote host
|
||||
ssh -i "$cert_path" "$host" "chmod +x ~/security-report.sh && sudo ~/security-report.sh ${temp_file}" >&2
|
||||
|
||||
# Copy the report back
|
||||
scp -i "$cert_path" "${host}:${temp_file}" "${temp_file}" >&2
|
||||
|
||||
# Cleanup remote files
|
||||
ssh -i "$cert_path" "$host" "rm ~/security-report.sh ${temp_file}" >&2
|
||||
|
||||
# Output the local file path for fabric to read
|
||||
echo "${temp_file}"
|
||||
|
||||
17
plugins/template/Examples/remote-security-report.yaml
Normal file
17
plugins/template/Examples/remote-security-report.yaml
Normal file
@@ -0,0 +1,17 @@
|
||||
name: "remote-security"
|
||||
executable: "/usr/local/bin/remote-security-report.sh"
|
||||
type: "executable"
|
||||
timeout: "60s"
|
||||
description: "Generate security report from remote system"
|
||||
|
||||
operations:
|
||||
report:
|
||||
cmd_template: "{{executable}} {{1}} {{2}} {{3}}"
|
||||
|
||||
config:
|
||||
output:
|
||||
method: "file"
|
||||
file_config:
|
||||
cleanup: true
|
||||
path_from_stdout: true
|
||||
work_dir: "/tmp"
|
||||
113
plugins/template/Examples/security-report.sh
Executable file
113
plugins/template/Examples/security-report.sh
Executable file
@@ -0,0 +1,113 @@
|
||||
#!/bin/bash
|
||||
|
||||
# security-report.sh - Enhanced system security information collection
|
||||
# Usage: security-report.sh [output_file]
|
||||
|
||||
output_file=${1:-/tmp/security-report.txt}
|
||||
|
||||
{
|
||||
echo "=== System Security Report ==="
|
||||
echo "Generated: $(date)"
|
||||
echo "Hostname: $(hostname)"
|
||||
echo "Kernel: $(uname -r)"
|
||||
echo
|
||||
|
||||
echo "=== System Updates ==="
|
||||
echo "Last update: $(stat -c %y /var/cache/apt/pkgcache.bin | cut -d' ' -f1)"
|
||||
echo "Pending updates:"
|
||||
apt list --upgradable 2>/dev/null
|
||||
|
||||
echo -e "\n=== Security Updates ==="
|
||||
echo "Pending security updates:"
|
||||
apt list --upgradable 2>/dev/null | grep -i security
|
||||
|
||||
echo -e "\n=== User Accounts ==="
|
||||
echo "Users with login shells:"
|
||||
grep -v '/nologin\|/false' /etc/passwd
|
||||
echo -e "\nUsers who can login:"
|
||||
awk -F: '$2!="*" && $2!="!" {print $1}' /etc/shadow
|
||||
echo -e "\nUsers with empty passwords:"
|
||||
awk -F: '$2=="" {print $1}' /etc/shadow
|
||||
echo -e "\nUsers with UID 0:"
|
||||
awk -F: '$3==0 {print $1}' /etc/passwd
|
||||
|
||||
echo -e "\n=== Sudo Configuration ==="
|
||||
echo "Users/groups with sudo privileges:"
|
||||
grep -h '^[^#]' /etc/sudoers.d/* /etc/sudoers 2>/dev/null
|
||||
echo -e "\nUsers with passwordless sudo:"
|
||||
grep -h NOPASSWD /etc/sudoers.d/* /etc/sudoers 2>/dev/null
|
||||
|
||||
echo -e "\n=== SSH Configuration ==="
|
||||
if [ -f /etc/ssh/sshd_config ]; then
|
||||
echo "Key SSH settings:"
|
||||
grep -E '^(PermitRootLogin|PasswordAuthentication|Port|Protocol|X11Forwarding|MaxAuthTries|PermitEmptyPasswords)' /etc/ssh/sshd_config
|
||||
fi
|
||||
|
||||
echo -e "\n=== SSH Keys ==="
|
||||
echo "Authorized keys found:"
|
||||
find /home -name "authorized_keys" -ls 2>/dev/null
|
||||
|
||||
echo -e "\n=== Firewall Status ==="
|
||||
echo "UFW Status:"
|
||||
ufw status verbose
|
||||
echo -e "\nIPTables Rules:"
|
||||
iptables -L -n
|
||||
|
||||
echo -e "\n=== Network Services ==="
|
||||
echo "Listening services (port - process):"
|
||||
netstat -tlpn 2>/dev/null | grep LISTEN
|
||||
|
||||
echo -e "\n=== Recent Authentication Failures ==="
|
||||
echo "Last 5 failed SSH attempts:"
|
||||
grep "Failed password" /var/log/auth.log | tail -5
|
||||
|
||||
echo -e "\n=== File Permissions ==="
|
||||
echo "World-writable files in /etc:"
|
||||
find /etc -type f -perm -002 -ls 2>/dev/null
|
||||
echo -e "\nWorld-writable directories in /etc:"
|
||||
find /etc -type d -perm -002 -ls 2>/dev/null
|
||||
|
||||
echo -e "\n=== System Resource Usage ==="
|
||||
echo "Disk Usage:"
|
||||
df -h
|
||||
echo -e "\nMemory Usage:"
|
||||
free -h
|
||||
echo -e "\nTop 5 CPU-using processes:"
|
||||
ps aux --sort=-%cpu | head -6
|
||||
|
||||
echo -e "\n=== System Timers ==="
|
||||
echo "Active timers (potential scheduled tasks):"
|
||||
systemctl list-timers --all
|
||||
|
||||
echo -e "\n=== Important Service Status ==="
|
||||
for service in ssh ufw apparmor fail2ban clamav-freshclam; do
|
||||
echo "Status of $service:"
|
||||
systemctl status $service --no-pager 2>/dev/null
|
||||
done
|
||||
|
||||
echo -e "\n=== Fail2Ban Logs ==="
|
||||
echo "Recent Fail2Ban activity (fail2ban.log):"
|
||||
if [ -f /var/log/fail2ban.log ]; then
|
||||
echo "=== Current log (fail2ban.log) ==="
|
||||
cat /var/log/fail2ban.log
|
||||
else
|
||||
echo "fail2ban.log not found"
|
||||
fi
|
||||
|
||||
if [ -f /var/log/fail2ban.log.1 ]; then
|
||||
echo -e "\n=== Previous log (fail2ban.log.1) ==="
|
||||
cat /var/log/fail2ban.log.1
|
||||
else
|
||||
echo -e "\nfail2ban.log.1 not found"
|
||||
fi
|
||||
|
||||
echo -e "\n=== Fail2Ban Status ==="
|
||||
echo "Currently banned IPs:"
|
||||
sudo fail2ban-client status
|
||||
|
||||
|
||||
} > "$output_file"
|
||||
|
||||
# Output the file path for fabric to read
|
||||
echo "$output_file"
|
||||
|
||||
18
plugins/template/Examples/security-report.yaml
Normal file
18
plugins/template/Examples/security-report.yaml
Normal file
@@ -0,0 +1,18 @@
|
||||
name: "security-report"
|
||||
executable: "/usr/local/bin/security-report.sh"
|
||||
type: "executable"
|
||||
timeout: "30s"
|
||||
description: "Generate system security report"
|
||||
version: "1.0.0"
|
||||
|
||||
operations:
|
||||
generate:
|
||||
cmd_template: "{{executable}} /tmp/security-report-{{1}}.txt"
|
||||
|
||||
config:
|
||||
output:
|
||||
method: "file"
|
||||
file_config:
|
||||
cleanup: true
|
||||
path_from_stdout: true
|
||||
work_dir: "/tmp"
|
||||
23
plugins/template/Examples/sqlite3_demo.yaml
Normal file
23
plugins/template/Examples/sqlite3_demo.yaml
Normal file
@@ -0,0 +1,23 @@
|
||||
name: memory-query
|
||||
executable: /usr/bin/sqlite3
|
||||
type: executable
|
||||
timeout: "5s"
|
||||
description: "Query memories database"
|
||||
version: "1.0.0"
|
||||
env: []
|
||||
|
||||
operations:
|
||||
goal:
|
||||
cmd_template: "{{executable}} -json /home/matt/memories.db \"select * from memories where type= 'goal'\""
|
||||
value:
|
||||
cmd_template: "{{executable}} -json /home/matt/memories.db \"select * from memories where type= 'value'\""
|
||||
project:
|
||||
cmd_template: "{{executable}} -json /home/matt/memories.db \"select * from memories where type= 'project'\""
|
||||
byid:
|
||||
cmd_template: "{{executable}} -json /home/matt/memories.db \"select * from memories where uid= {{value}}\""
|
||||
all:
|
||||
cmd_template: "{{executable}} -json ~/memories.db \"select * from memories\""
|
||||
|
||||
config:
|
||||
output:
|
||||
method: stdout
|
||||
8
plugins/template/Examples/test_pattern.md
Normal file
8
plugins/template/Examples/test_pattern.md
Normal file
@@ -0,0 +1,8 @@
|
||||
These are my favorite
|
||||
{{ext:word-generator:generate:3}}
|
||||
|
||||
These are my least favorite
|
||||
{{ext:word-generator:generate:2}}
|
||||
|
||||
what does this say about me?
|
||||
|
||||
18
plugins/template/Examples/track_packages.sh
Executable file
18
plugins/template/Examples/track_packages.sh
Executable file
@@ -0,0 +1,18 @@
|
||||
#!/bin/bash
|
||||
|
||||
LOG_DIR="/var/log/package_tracking"
|
||||
DATE=$(date +%Y%m%d)
|
||||
|
||||
# Ensure directory exists
|
||||
mkdir -p "$LOG_DIR"
|
||||
|
||||
# Current package list
|
||||
dpkg -l > "$LOG_DIR/packages_current.list"
|
||||
|
||||
# Create diff if previous exists
|
||||
if [ -f "$LOG_DIR/packages_previous.list" ]; then
|
||||
diff "$LOG_DIR/packages_previous.list" "$LOG_DIR/packages_current.list" > "$LOG_DIR/changes_current.diff"
|
||||
fi
|
||||
|
||||
# Keep copy for next comparison
|
||||
cp "$LOG_DIR/packages_current.list" "$LOG_DIR/packages_previous.list"
|
||||
36
plugins/template/Examples/word-generator.py
Executable file
36
plugins/template/Examples/word-generator.py
Executable file
@@ -0,0 +1,36 @@
|
||||
#!/usr/bin/env python3
|
||||
import sys
|
||||
import json
|
||||
import random
|
||||
|
||||
# A small set of words for demonstration!
|
||||
WORD_LIST = [
|
||||
"apple", "banana", "cherry", "date", "elderberry",
|
||||
"fig", "grape", "honeydew", "kiwi", "lemon",
|
||||
"mango", "nectarine", "orange", "papaya", "quince",
|
||||
"raspberry", "strawberry", "tangerine", "ugli", "watermelon"
|
||||
]
|
||||
|
||||
def generate_words(count):
|
||||
try:
|
||||
count = int(count)
|
||||
if count < 1:
|
||||
return json.dumps({"error": "Count must be positive"})
|
||||
|
||||
# Generate random words
|
||||
words = random.sample(WORD_LIST, min(count, len(WORD_LIST)))
|
||||
|
||||
# Return JSON formatted result
|
||||
return json.dumps({
|
||||
"words": words,
|
||||
"count": len(words)
|
||||
})
|
||||
except ValueError:
|
||||
return json.dumps({"error": "Invalid count parameter"})
|
||||
|
||||
if __name__ == "__main__":
|
||||
if len(sys.argv) != 2:
|
||||
print(json.dumps({"error": "Exactly one argument required"}))
|
||||
sys.exit(1)
|
||||
|
||||
print(generate_words(sys.argv[1]))
|
||||
16
plugins/template/Examples/word-generator.yaml
Normal file
16
plugins/template/Examples/word-generator.yaml
Normal file
@@ -0,0 +1,16 @@
|
||||
name: word-generator
|
||||
executable: /usr/local/bin/word-generator.py
|
||||
type: executable
|
||||
timeout: "5s"
|
||||
description: "Generates random words based on count parameter"
|
||||
version: "1.0.0"
|
||||
env: []
|
||||
|
||||
operations:
|
||||
generate:
|
||||
cmd_template: "{{executable}} {{value}}"
|
||||
|
||||
config:
|
||||
output:
|
||||
method: stdout
|
||||
|
||||
196
plugins/template/extension_executor.go
Normal file
196
plugins/template/extension_executor.go
Normal file
@@ -0,0 +1,196 @@
|
||||
package template
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
"os/exec"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
// ExtensionExecutor handles the secure execution of extensions
|
||||
// It uses the registry to verify extensions before running them
|
||||
type ExtensionExecutor struct {
|
||||
registry *ExtensionRegistry
|
||||
}
|
||||
|
||||
// NewExtensionExecutor creates a new executor instance
|
||||
// It requires a registry to verify extensions
|
||||
func NewExtensionExecutor(registry *ExtensionRegistry) *ExtensionExecutor {
|
||||
return &ExtensionExecutor{
|
||||
registry: registry,
|
||||
}
|
||||
}
|
||||
|
||||
// Execute runs an extension with the given operation and value string
|
||||
// name: the registered name of the extension
|
||||
// operation: the operation to perform
|
||||
// value: the input value(s) for the operation
|
||||
// In extension_executor.go
|
||||
func (e *ExtensionExecutor) Execute(name, operation, value string) (string, error) {
|
||||
// Get and verify extension from registry
|
||||
ext, err := e.registry.GetExtension(name)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to get extension: %w", err)
|
||||
}
|
||||
|
||||
// Format the command using our template system
|
||||
cmdStr, err := e.formatCommand(ext, operation, value)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to format command: %w", err)
|
||||
}
|
||||
|
||||
// Split the command string into command and arguments
|
||||
cmdParts := strings.Fields(cmdStr)
|
||||
if len(cmdParts) < 1 {
|
||||
return "", fmt.Errorf("empty command after formatting")
|
||||
}
|
||||
|
||||
// Create command with the Executable and formatted arguments
|
||||
cmd := exec.Command("sh", "-c", cmdStr)
|
||||
//cmd := exec.Command(cmdParts[0], cmdParts[1:]...)
|
||||
|
||||
// Set up environment if specified
|
||||
if len(ext.Env) > 0 {
|
||||
cmd.Env = append(os.Environ(), ext.Env...)
|
||||
}
|
||||
|
||||
// Execute based on output method
|
||||
outputMethod := ext.GetOutputMethod()
|
||||
if outputMethod == "file" {
|
||||
return e.executeWithFile(cmd, ext)
|
||||
}
|
||||
return e.executeStdout(cmd, ext)
|
||||
}
|
||||
|
||||
// formatCommand uses fabric's template system to format the command
|
||||
// It creates a variables map for the template system using the input values
|
||||
func (e *ExtensionExecutor) formatCommand(ext *ExtensionDefinition, operation string, value string) (string, error) {
|
||||
// Get operation config
|
||||
opConfig, exists := ext.Operations[operation]
|
||||
if !exists {
|
||||
return "", fmt.Errorf("operation %s not found for extension %s", operation, ext.Name)
|
||||
}
|
||||
|
||||
vars := make(map[string]string)
|
||||
vars["executable"] = ext.Executable
|
||||
vars["operation"] = operation
|
||||
vars["value"] = value
|
||||
|
||||
// Split on pipe for numbered variables
|
||||
values := strings.Split(value, "|")
|
||||
for i, val := range values {
|
||||
vars[fmt.Sprintf("%d", i+1)] = val
|
||||
}
|
||||
|
||||
return ApplyTemplate(opConfig.CmdTemplate, vars, "")
|
||||
}
|
||||
|
||||
// executeStdout runs the command and captures its stdout
|
||||
func (e *ExtensionExecutor) executeStdout(cmd *exec.Cmd, ext *ExtensionDefinition) (string, error) {
|
||||
var stdout bytes.Buffer
|
||||
var stderr bytes.Buffer
|
||||
cmd.Stdout = &stdout
|
||||
cmd.Stderr = &stderr
|
||||
|
||||
//debug output
|
||||
fmt.Printf("Executing command: %s\n", cmd.String())
|
||||
|
||||
if err := cmd.Run(); err != nil {
|
||||
return "", fmt.Errorf("execution failed: %w\nstderr: %s", err, stderr.String())
|
||||
}
|
||||
|
||||
return stdout.String(), nil
|
||||
}
|
||||
|
||||
// executeWithFile runs the command and handles file-based output
|
||||
func (e *ExtensionExecutor) executeWithFile(cmd *exec.Cmd, ext *ExtensionDefinition) (string, error) {
|
||||
// Parse timeout - this is now a first-class field
|
||||
timeout, err := time.ParseDuration(ext.Timeout)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("invalid timeout format: %w", err)
|
||||
}
|
||||
|
||||
// Create context with timeout
|
||||
ctx, cancel := context.WithTimeout(context.Background(), timeout)
|
||||
defer cancel()
|
||||
cmd = exec.CommandContext(ctx, cmd.Path, cmd.Args[1:]...)
|
||||
cmd.Env = cmd.Env
|
||||
|
||||
fileConfig := ext.GetFileConfig()
|
||||
if fileConfig == nil {
|
||||
return "", fmt.Errorf("no file configuration found")
|
||||
}
|
||||
|
||||
// Handle path from stdout case
|
||||
if pathFromStdout, ok := fileConfig["path_from_stdout"].(bool); ok && pathFromStdout {
|
||||
return e.handlePathFromStdout(cmd, ext)
|
||||
}
|
||||
|
||||
// Handle fixed file case
|
||||
workDir, _ := fileConfig["work_dir"].(string)
|
||||
outputFile, _ := fileConfig["output_file"].(string)
|
||||
|
||||
if outputFile == "" {
|
||||
return "", fmt.Errorf("no output file specified in configuration")
|
||||
}
|
||||
|
||||
// Set working directory if specified
|
||||
if workDir != "" {
|
||||
cmd.Dir = workDir
|
||||
}
|
||||
|
||||
var stderr bytes.Buffer
|
||||
cmd.Stderr = &stderr
|
||||
|
||||
if err := cmd.Run(); err != nil {
|
||||
if ctx.Err() == context.DeadlineExceeded {
|
||||
return "", fmt.Errorf("execution timed out after %v", timeout)
|
||||
}
|
||||
return "", fmt.Errorf("execution failed: %w\nerr: %s", err, stderr.String())
|
||||
}
|
||||
|
||||
// Construct full file path
|
||||
outputPath := outputFile
|
||||
if workDir != "" {
|
||||
outputPath = filepath.Join(workDir, outputFile)
|
||||
}
|
||||
|
||||
content, err := os.ReadFile(outputPath)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to read output file: %w", err)
|
||||
}
|
||||
|
||||
// Handle cleanup if enabled
|
||||
if ext.IsCleanupEnabled() {
|
||||
defer os.Remove(outputPath)
|
||||
}
|
||||
|
||||
return string(content), nil
|
||||
}
|
||||
|
||||
// Helper method to handle path from stdout case
|
||||
func (e *ExtensionExecutor) handlePathFromStdout(cmd *exec.Cmd, ext *ExtensionDefinition) (string, error) {
|
||||
var stdout, stderr bytes.Buffer
|
||||
cmd.Stdout = &stdout
|
||||
cmd.Stderr = &stderr
|
||||
|
||||
if err := cmd.Run(); err != nil {
|
||||
return "", fmt.Errorf("failed to get output path: %w\nerr: %s", err, stderr.String())
|
||||
}
|
||||
|
||||
outputPath := strings.TrimSpace(stdout.String())
|
||||
content, err := os.ReadFile(outputPath)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to read output file: %w", err)
|
||||
}
|
||||
|
||||
if ext.IsCleanupEnabled() {
|
||||
defer os.Remove(outputPath)
|
||||
}
|
||||
|
||||
return string(content), nil
|
||||
}
|
||||
360
plugins/template/extension_executor_test.go
Normal file
360
plugins/template/extension_executor_test.go
Normal file
@@ -0,0 +1,360 @@
|
||||
package template
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestExtensionExecutor(t *testing.T) {
|
||||
tmpDir, err := os.MkdirTemp("", "fabric-ext-executor-*")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp directory: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
// Create test script that has both stdout and file output modes
|
||||
testScript := filepath.Join(tmpDir, "test-script.sh")
|
||||
scriptContent := `#!/bin/bash
|
||||
case "$1" in
|
||||
"stdout")
|
||||
echo "Hello, $2!"
|
||||
;;
|
||||
"file")
|
||||
echo "Hello, $2!" > "$3"
|
||||
echo "$3" # Print the filename for path_from_stdout
|
||||
;;
|
||||
*)
|
||||
echo "Unknown command" >&2
|
||||
exit 1
|
||||
;;
|
||||
esac`
|
||||
|
||||
if err := os.WriteFile(testScript, []byte(scriptContent), 0755); err != nil {
|
||||
t.Fatalf("Failed to create test script: %v", err)
|
||||
}
|
||||
|
||||
// Create registry and register our test extensions
|
||||
registry := NewExtensionRegistry(tmpDir)
|
||||
executor := NewExtensionExecutor(registry)
|
||||
|
||||
// Test stdout-based extension
|
||||
t.Run("StdoutExecution", func(t *testing.T) {
|
||||
configPath := filepath.Join(tmpDir, "stdout-extension.yaml")
|
||||
configContent := `name: stdout-test
|
||||
executable: ` + testScript + `
|
||||
type: executable
|
||||
timeout: 30s
|
||||
operations:
|
||||
greet:
|
||||
cmd_template: "{{executable}} stdout {{1}}"
|
||||
config:
|
||||
output:
|
||||
method: stdout`
|
||||
|
||||
if err := os.WriteFile(configPath, []byte(configContent), 0644); err != nil {
|
||||
t.Fatalf("Failed to create config: %v", err)
|
||||
}
|
||||
|
||||
if err := registry.Register(configPath); err != nil {
|
||||
t.Fatalf("Failed to register extension: %v", err)
|
||||
}
|
||||
|
||||
output, err := executor.Execute("stdout-test", "greet", "World")
|
||||
if err != nil {
|
||||
t.Errorf("Failed to execute: %v", err)
|
||||
}
|
||||
|
||||
expected := "Hello, World!\n"
|
||||
if output != expected {
|
||||
t.Errorf("Expected output %q, got %q", expected, output)
|
||||
}
|
||||
})
|
||||
|
||||
// Test file-based extension
|
||||
t.Run("FileExecution", func(t *testing.T) {
|
||||
configPath := filepath.Join(tmpDir, "file-extension.yaml")
|
||||
configContent := `name: file-test
|
||||
executable: ` + testScript + `
|
||||
type: executable
|
||||
timeout: 30s
|
||||
operations:
|
||||
greet:
|
||||
cmd_template: "{{executable}} file {{1}} {{2}}"
|
||||
config:
|
||||
output:
|
||||
method: file
|
||||
file_config:
|
||||
cleanup: true
|
||||
path_from_stdout: true`
|
||||
|
||||
if err := os.WriteFile(configPath, []byte(configContent), 0644); err != nil {
|
||||
t.Fatalf("Failed to create config: %v", err)
|
||||
}
|
||||
|
||||
if err := registry.Register(configPath); err != nil {
|
||||
t.Fatalf("Failed to register extension: %v", err)
|
||||
}
|
||||
|
||||
output, err := executor.Execute("file-test", "greet", "World|/tmp/test.txt")
|
||||
if err != nil {
|
||||
t.Errorf("Failed to execute: %v", err)
|
||||
}
|
||||
|
||||
expected := "Hello, World!\n"
|
||||
if output != expected {
|
||||
t.Errorf("Expected output %q, got %q", expected, output)
|
||||
}
|
||||
})
|
||||
|
||||
// Test execution errors
|
||||
t.Run("ExecutionErrors", func(t *testing.T) {
|
||||
// Test with non-existent extension
|
||||
_, err := executor.Execute("nonexistent", "test", "value")
|
||||
if err == nil {
|
||||
t.Error("Expected error executing non-existent extension, got nil")
|
||||
}
|
||||
|
||||
// Test with invalid command that should exit non-zero
|
||||
configPath := filepath.Join(tmpDir, "error-extension.yaml")
|
||||
configContent := `name: error-test
|
||||
executable: ` + testScript + `
|
||||
type: executable
|
||||
timeout: 30s
|
||||
operations:
|
||||
invalid:
|
||||
cmd_template: "{{executable}} invalid {{1}}"
|
||||
config:
|
||||
output:
|
||||
method: stdout`
|
||||
|
||||
if err := os.WriteFile(configPath, []byte(configContent), 0644); err != nil {
|
||||
t.Fatalf("Failed to create config: %v", err)
|
||||
}
|
||||
|
||||
if err := registry.Register(configPath); err != nil {
|
||||
t.Fatalf("Failed to register extension: %v", err)
|
||||
}
|
||||
|
||||
_, err = executor.Execute("error-test", "invalid", "test")
|
||||
if err == nil {
|
||||
t.Error("Expected error from invalid command, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "Unknown command") {
|
||||
t.Errorf("Expected 'Unknown command' in error, got: %v", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestFixedFileExtensionExecutor(t *testing.T) {
|
||||
tmpDir, err := os.MkdirTemp("", "fabric-ext-executor-fixed-*")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp directory: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
// Create test script
|
||||
testScript := filepath.Join(tmpDir, "test-script.sh")
|
||||
scriptContent := `#!/bin/bash
|
||||
case "$1" in
|
||||
"write")
|
||||
echo "Hello, $2!" > "$3"
|
||||
;;
|
||||
"append")
|
||||
echo "Hello, $2!" >> "$3"
|
||||
;;
|
||||
"large")
|
||||
for i in {1..1000}; do
|
||||
echo "Line $i" >> "$3"
|
||||
done
|
||||
;;
|
||||
"error")
|
||||
echo "Error message" >&2
|
||||
exit 1
|
||||
;;
|
||||
*)
|
||||
echo "Unknown command" >&2
|
||||
exit 1
|
||||
;;
|
||||
esac`
|
||||
|
||||
if err := os.WriteFile(testScript, []byte(scriptContent), 0755); err != nil {
|
||||
t.Fatalf("Failed to create test script: %v", err)
|
||||
}
|
||||
|
||||
registry := NewExtensionRegistry(tmpDir)
|
||||
executor := NewExtensionExecutor(registry)
|
||||
|
||||
// Helper function to create and register extension
|
||||
createExtension := func(name, opName, cmdTemplate string, config map[string]interface{}) error {
|
||||
configPath := filepath.Join(tmpDir, name+".yaml")
|
||||
configContent := `name: ` + name + `
|
||||
executable: ` + testScript + `
|
||||
type: executable
|
||||
timeout: 30s
|
||||
operations:
|
||||
` + opName + `:
|
||||
cmd_template: "` + cmdTemplate + `"
|
||||
config:
|
||||
output:
|
||||
method: file
|
||||
file_config:`
|
||||
|
||||
// Add config options
|
||||
for k, v := range config {
|
||||
configContent += "\n " + k + ": " + strings.TrimSpace(v.(string))
|
||||
}
|
||||
|
||||
if err := os.WriteFile(configPath, []byte(configContent), 0644); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return registry.Register(configPath)
|
||||
}
|
||||
|
||||
// Test basic fixed file output
|
||||
t.Run("BasicFixedFile", func(t *testing.T) {
|
||||
outputFile := filepath.Join(tmpDir, "output.txt")
|
||||
config := map[string]interface{}{
|
||||
"output_file": `"output.txt"`,
|
||||
"work_dir": `"` + tmpDir + `"`,
|
||||
"cleanup": "true",
|
||||
}
|
||||
|
||||
err := createExtension("basic-test", "write",
|
||||
"{{executable}} write {{1}} "+outputFile, config)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create extension: %v", err)
|
||||
}
|
||||
|
||||
output, err := executor.Execute("basic-test", "write", "World")
|
||||
if err != nil {
|
||||
t.Errorf("Failed to execute: %v", err)
|
||||
}
|
||||
|
||||
expected := "Hello, World!\n"
|
||||
if output != expected {
|
||||
t.Errorf("Expected output %q, got %q", expected, output)
|
||||
}
|
||||
})
|
||||
|
||||
// Test no work_dir specified
|
||||
t.Run("NoWorkDir", func(t *testing.T) {
|
||||
config := map[string]interface{}{
|
||||
"output_file": `"direct-output.txt"`,
|
||||
"cleanup": "true",
|
||||
}
|
||||
|
||||
err := createExtension("no-workdir-test", "write",
|
||||
"{{executable}} write {{1}} direct-output.txt", config)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create extension: %v", err)
|
||||
}
|
||||
|
||||
_, err = executor.Execute("no-workdir-test", "write", "World")
|
||||
if err != nil {
|
||||
t.Errorf("Failed to execute: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
// Test cleanup behavior
|
||||
t.Run("CleanupBehavior", func(t *testing.T) {
|
||||
outputFile := filepath.Join(tmpDir, "cleanup-test.txt")
|
||||
|
||||
// Test with cleanup enabled
|
||||
config := map[string]interface{}{
|
||||
"output_file": `"cleanup-test.txt"`,
|
||||
"work_dir": `"` + tmpDir + `"`,
|
||||
"cleanup": "true",
|
||||
}
|
||||
|
||||
err := createExtension("cleanup-test", "write",
|
||||
"{{executable}} write {{1}} "+outputFile, config)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create extension: %v", err)
|
||||
}
|
||||
|
||||
_, err = executor.Execute("cleanup-test", "write", "World")
|
||||
if err != nil {
|
||||
t.Errorf("Failed to execute: %v", err)
|
||||
}
|
||||
|
||||
// File should be deleted after execution
|
||||
if _, err := os.Stat(outputFile); !os.IsNotExist(err) {
|
||||
t.Error("Expected output file to be cleaned up")
|
||||
}
|
||||
|
||||
// Test with cleanup disabled
|
||||
config["cleanup"] = "false"
|
||||
err = createExtension("no-cleanup-test", "write",
|
||||
"{{executable}} write {{1}} "+outputFile, config)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create extension: %v", err)
|
||||
}
|
||||
|
||||
_, err = executor.Execute("no-cleanup-test", "write", "World")
|
||||
if err != nil {
|
||||
t.Errorf("Failed to execute: %v", err)
|
||||
}
|
||||
|
||||
// File should remain after execution
|
||||
if _, err := os.Stat(outputFile); os.IsNotExist(err) {
|
||||
t.Error("Expected output file to remain")
|
||||
}
|
||||
})
|
||||
|
||||
// Test error cases
|
||||
t.Run("ErrorCases", func(t *testing.T) {
|
||||
outputFile := filepath.Join(tmpDir, "error-test.txt")
|
||||
config := map[string]interface{}{
|
||||
"output_file": `"error-test.txt"`,
|
||||
"work_dir": `"` + tmpDir + `"`,
|
||||
"cleanup": "true",
|
||||
}
|
||||
|
||||
// Test command error
|
||||
err := createExtension("error-test", "error",
|
||||
"{{executable}} error {{1}} "+outputFile, config)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create extension: %v", err)
|
||||
}
|
||||
|
||||
_, err = executor.Execute("error-test", "error", "World")
|
||||
if err == nil {
|
||||
t.Error("Expected error from failing command, got nil")
|
||||
}
|
||||
|
||||
// Test invalid work_dir
|
||||
config["work_dir"] = `"/nonexistent/directory"`
|
||||
err = createExtension("invalid-dir-test", "write",
|
||||
"{{executable}} write {{1}} output.txt", config)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create extension: %v", err)
|
||||
}
|
||||
|
||||
_, err = executor.Execute("invalid-dir-test", "write", "World")
|
||||
if err == nil {
|
||||
t.Error("Expected error from invalid work_dir, got nil")
|
||||
}
|
||||
})
|
||||
|
||||
// Test with missing output_file
|
||||
t.Run("MissingOutputFile", func(t *testing.T) {
|
||||
config := map[string]interface{}{
|
||||
"work_dir": `"` + tmpDir + `"`,
|
||||
"cleanup": "true",
|
||||
}
|
||||
|
||||
err := createExtension("missing-output-test", "write",
|
||||
"{{executable}} write {{1}} output.txt", config)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create extension: %v", err)
|
||||
}
|
||||
|
||||
_, err = executor.Execute("missing-output-test", "write", "World")
|
||||
if err == nil {
|
||||
t.Error("Expected error from missing output_file, got nil")
|
||||
}
|
||||
})
|
||||
}
|
||||
135
plugins/template/extension_manager.go
Normal file
135
plugins/template/extension_manager.go
Normal file
@@ -0,0 +1,135 @@
|
||||
package template
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"time"
|
||||
|
||||
"gopkg.in/yaml.v3"
|
||||
)
|
||||
|
||||
// ExtensionManager handles the high-level operations of the extension system
|
||||
type ExtensionManager struct {
|
||||
registry *ExtensionRegistry
|
||||
executor *ExtensionExecutor
|
||||
configDir string
|
||||
}
|
||||
|
||||
// NewExtensionManager creates a new extension manager instance
|
||||
func NewExtensionManager(configDir string) *ExtensionManager {
|
||||
registry := NewExtensionRegistry(configDir)
|
||||
return &ExtensionManager{
|
||||
registry: registry,
|
||||
executor: NewExtensionExecutor(registry),
|
||||
configDir: configDir,
|
||||
}
|
||||
}
|
||||
|
||||
// ListExtensions handles the listextensions flag action
|
||||
func (em *ExtensionManager) ListExtensions() error {
|
||||
if em.registry == nil || em.registry.registry.Extensions == nil {
|
||||
return fmt.Errorf("extension registry not initialized")
|
||||
}
|
||||
|
||||
for name, entry := range em.registry.registry.Extensions {
|
||||
fmt.Printf("Extension: %s\n", name)
|
||||
|
||||
// Try to load extension details
|
||||
ext, err := em.registry.GetExtension(name)
|
||||
if err != nil {
|
||||
fmt.Printf(" Status: DISABLED - Hash verification failed: %v\n", err)
|
||||
fmt.Printf(" Config Path: %s\n\n", entry.ConfigPath)
|
||||
continue
|
||||
}
|
||||
|
||||
// Print extension details if verification succeeded
|
||||
fmt.Printf(" Status: ENABLED\n")
|
||||
fmt.Printf(" Executable: %s\n", ext.Executable)
|
||||
fmt.Printf(" Type: %s\n", ext.Type)
|
||||
fmt.Printf(" Timeout: %s\n", ext.Timeout)
|
||||
fmt.Printf(" Description: %s\n", ext.Description)
|
||||
fmt.Printf(" Version: %s\n", ext.Version)
|
||||
|
||||
fmt.Printf(" Operations:\n")
|
||||
for opName, opConfig := range ext.Operations {
|
||||
fmt.Printf(" %s:\n", opName)
|
||||
fmt.Printf(" Command Template: %s\n", opConfig.CmdTemplate)
|
||||
}
|
||||
|
||||
if fileConfig := ext.GetFileConfig(); fileConfig != nil {
|
||||
fmt.Printf(" File Configuration:\n")
|
||||
for k, v := range fileConfig {
|
||||
fmt.Printf(" %s: %v\n", k, v)
|
||||
}
|
||||
}
|
||||
fmt.Printf("\n")
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// RegisterExtension handles the addextension flag action
|
||||
func (em *ExtensionManager) RegisterExtension(configPath string) error {
|
||||
absPath, err := filepath.Abs(configPath)
|
||||
if err != nil {
|
||||
return fmt.Errorf("invalid config path: %w", err)
|
||||
}
|
||||
|
||||
// Get extension name before registration for status message
|
||||
data, err := os.ReadFile(absPath)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to read config file: %w", err)
|
||||
}
|
||||
|
||||
var ext ExtensionDefinition
|
||||
if err := yaml.Unmarshal(data, &ext); err != nil {
|
||||
return fmt.Errorf("failed to parse config file: %w", err)
|
||||
}
|
||||
|
||||
if err := em.registry.Register(absPath); err != nil {
|
||||
return fmt.Errorf("failed to register extension: %w", err)
|
||||
}
|
||||
|
||||
if _, err := time.ParseDuration(ext.Timeout); err != nil {
|
||||
return fmt.Errorf("invalid timeout value '%s': must be a duration like '30s' or '1m': %w", ext.Timeout, err)
|
||||
}
|
||||
|
||||
// Print success message with extension details
|
||||
fmt.Printf("Successfully registered extension:\n")
|
||||
fmt.Printf("Name: %s\n", ext.Name)
|
||||
fmt.Printf(" Executable: %s\n", ext.Executable)
|
||||
fmt.Printf(" Type: %s\n", ext.Type)
|
||||
fmt.Printf(" Timeout: %s\n", ext.Timeout)
|
||||
fmt.Printf(" Description: %s\n", ext.Description)
|
||||
fmt.Printf(" Version: %s\n", ext.Version)
|
||||
|
||||
fmt.Printf(" Operations:\n")
|
||||
for opName, opConfig := range ext.Operations {
|
||||
fmt.Printf(" %s:\n", opName)
|
||||
fmt.Printf(" Command Template: %s\n", opConfig.CmdTemplate)
|
||||
}
|
||||
|
||||
if fileConfig := ext.GetFileConfig(); fileConfig != nil {
|
||||
fmt.Printf(" File Configuration:\n")
|
||||
for k, v := range fileConfig {
|
||||
fmt.Printf(" %s: %v\n", k, v)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// RemoveExtension handles the rmextension flag action
|
||||
func (em *ExtensionManager) RemoveExtension(name string) error {
|
||||
if err := em.registry.Remove(name); err != nil {
|
||||
return fmt.Errorf("failed to remove extension: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// ProcessExtension handles template processing for extension directives
|
||||
func (em *ExtensionManager) ProcessExtension(name, operation, value string) (string, error) {
|
||||
return em.executor.Execute(name, operation, value)
|
||||
}
|
||||
184
plugins/template/extension_manager_test.go
Normal file
184
plugins/template/extension_manager_test.go
Normal file
@@ -0,0 +1,184 @@
|
||||
package template
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// TestExtensionManager is the main test suite for ExtensionManager
|
||||
func TestExtensionManager(t *testing.T) {
|
||||
// Create temporary directory for tests
|
||||
tmpDir, err := os.MkdirTemp("", "fabric-ext-test-*")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp directory: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
// Create test extension config
|
||||
testConfig := filepath.Join(tmpDir, "test-extension.yaml")
|
||||
testScript := filepath.Join(tmpDir, "test-script.sh")
|
||||
|
||||
// Create test script
|
||||
scriptContent := `#!/bin/bash
|
||||
if [ "$1" = "echo" ]; then
|
||||
echo "Hello, $2!"
|
||||
fi`
|
||||
|
||||
err = os.WriteFile(testScript, []byte(scriptContent), 0755)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create test script: %v", err)
|
||||
}
|
||||
|
||||
// Create test config
|
||||
configContent := `name: test-extension
|
||||
executable: ` + testScript + `
|
||||
type: executable
|
||||
timeout: 30s
|
||||
description: "Test extension"
|
||||
version: "1.0.0"
|
||||
operations:
|
||||
echo:
|
||||
cmd_template: "{{executable}} echo {{1}}"
|
||||
`
|
||||
|
||||
err = os.WriteFile(testConfig, []byte(configContent), 0644)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create test config: %v", err)
|
||||
}
|
||||
|
||||
// Initialize manager
|
||||
manager := NewExtensionManager(tmpDir)
|
||||
|
||||
// Test cases
|
||||
t.Run("RegisterExtension", func(t *testing.T) {
|
||||
err := manager.RegisterExtension(testConfig)
|
||||
if err != nil {
|
||||
t.Errorf("Failed to register extension: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("ListExtensions", func(t *testing.T) {
|
||||
err := manager.ListExtensions()
|
||||
if err != nil {
|
||||
t.Errorf("Failed to list extensions: %v", err)
|
||||
}
|
||||
// Note: Output validation would require capturing stdout
|
||||
})
|
||||
|
||||
t.Run("ProcessExtension", func(t *testing.T) {
|
||||
output, err := manager.ProcessExtension("test-extension", "echo", "World")
|
||||
if err != nil {
|
||||
t.Errorf("Failed to process extension: %v", err)
|
||||
}
|
||||
expected := "Hello, World!\n"
|
||||
if output != expected {
|
||||
t.Errorf("Expected output %q, got %q", expected, output)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("RemoveExtension", func(t *testing.T) {
|
||||
err := manager.RemoveExtension("test-extension")
|
||||
if err != nil {
|
||||
t.Errorf("Failed to remove extension: %v", err)
|
||||
}
|
||||
|
||||
// Verify extension is removed by trying to process it
|
||||
_, err = manager.ProcessExtension("test-extension", "echo", "World")
|
||||
if err == nil {
|
||||
t.Error("Expected error processing removed extension, got nil")
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// TestExtensionManagerErrors tests error cases
|
||||
func TestExtensionManagerErrors(t *testing.T) {
|
||||
tmpDir, err := os.MkdirTemp("", "fabric-ext-test-errors-*")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp directory: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
manager := NewExtensionManager(tmpDir)
|
||||
|
||||
t.Run("RegisterNonexistentConfig", func(t *testing.T) {
|
||||
err := manager.RegisterExtension("/nonexistent/config.yaml")
|
||||
if err == nil {
|
||||
t.Error("Expected error registering nonexistent config, got nil")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("ProcessNonexistentExtension", func(t *testing.T) {
|
||||
_, err := manager.ProcessExtension("nonexistent", "echo", "test")
|
||||
if err == nil {
|
||||
t.Error("Expected error processing nonexistent extension, got nil")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("RemoveNonexistentExtension", func(t *testing.T) {
|
||||
err := manager.RemoveExtension("nonexistent")
|
||||
if err == nil {
|
||||
t.Error("Expected error removing nonexistent extension, got nil")
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// TestExtensionManagerWithInvalidConfig tests handling of invalid configurations
|
||||
func TestExtensionManagerWithInvalidConfig(t *testing.T) {
|
||||
tmpDir, err := os.MkdirTemp("", "fabric-ext-test-invalid-*")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp directory: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
invalidConfig := filepath.Join(tmpDir, "invalid-extension.yaml")
|
||||
|
||||
// Test cases with different invalid configurations
|
||||
testCases := []struct {
|
||||
name string
|
||||
config string
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "MissingExecutable",
|
||||
config: `name: invalid-extension
|
||||
type: executable
|
||||
timeout: 30s`,
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "InvalidTimeout",
|
||||
config: `name: invalid-extension
|
||||
executable: /bin/echo
|
||||
type: executable
|
||||
timeout: invalid`,
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "EmptyName",
|
||||
config: `name: ""
|
||||
executable: /bin/echo
|
||||
type: executable
|
||||
timeout: 30s`,
|
||||
wantErr: true,
|
||||
},
|
||||
}
|
||||
|
||||
manager := NewExtensionManager(tmpDir)
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
err := os.WriteFile(invalidConfig, []byte(tc.config), 0644)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create invalid config file: %v", err)
|
||||
}
|
||||
|
||||
err = manager.RegisterExtension(invalidConfig)
|
||||
if tc.wantErr && err == nil {
|
||||
t.Error("Expected error registering invalid config, got nil")
|
||||
} else if !tc.wantErr && err != nil {
|
||||
t.Errorf("Unexpected error registering config: %v", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
329
plugins/template/extension_registry.go
Normal file
329
plugins/template/extension_registry.go
Normal file
@@ -0,0 +1,329 @@
|
||||
package template
|
||||
|
||||
import (
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"gopkg.in/yaml.v3"
|
||||
// Add this import
|
||||
)
|
||||
|
||||
// ExtensionDefinition represents a single extension configuration
|
||||
type ExtensionDefinition struct {
|
||||
// Global properties
|
||||
Name string `yaml:"name"`
|
||||
Executable string `yaml:"executable"`
|
||||
Type string `yaml:"type"`
|
||||
Timeout string `yaml:"timeout"`
|
||||
Description string `yaml:"description"`
|
||||
Version string `yaml:"version"`
|
||||
Env []string `yaml:"env"`
|
||||
|
||||
// Operation-specific commands
|
||||
Operations map[string]OperationConfig `yaml:"operations"`
|
||||
|
||||
// Additional config
|
||||
Config map[string]interface{} `yaml:"config"`
|
||||
}
|
||||
|
||||
type OperationConfig struct {
|
||||
CmdTemplate string `yaml:"cmd_template"`
|
||||
}
|
||||
|
||||
// RegistryEntry represents a registered extension
|
||||
type RegistryEntry struct {
|
||||
ConfigPath string `yaml:"config_path"`
|
||||
ConfigHash string `yaml:"config_hash"`
|
||||
ExecutableHash string `yaml:"executable_hash"`
|
||||
}
|
||||
|
||||
type ExtensionRegistry struct {
|
||||
configDir string
|
||||
registry struct {
|
||||
Extensions map[string]*RegistryEntry `yaml:"extensions"`
|
||||
}
|
||||
}
|
||||
|
||||
// Helper methods for Config access
|
||||
func (e *ExtensionDefinition) GetOutputMethod() string {
|
||||
if output, ok := e.Config["output"].(map[string]interface{}); ok {
|
||||
if method, ok := output["method"].(string); ok {
|
||||
return method
|
||||
}
|
||||
}
|
||||
return "stdout" // default to stdout if not specified
|
||||
}
|
||||
|
||||
func (e *ExtensionDefinition) GetFileConfig() map[string]interface{} {
|
||||
if output, ok := e.Config["output"].(map[string]interface{}); ok {
|
||||
if fileConfig, ok := output["file_config"].(map[string]interface{}); ok {
|
||||
return fileConfig
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (e *ExtensionDefinition) IsCleanupEnabled() bool {
|
||||
if fc := e.GetFileConfig(); fc != nil {
|
||||
if cleanup, ok := fc["cleanup"].(bool); ok {
|
||||
return cleanup
|
||||
}
|
||||
}
|
||||
return false // default to no cleanup
|
||||
}
|
||||
|
||||
func NewExtensionRegistry(configDir string) *ExtensionRegistry {
|
||||
r := &ExtensionRegistry{
|
||||
configDir: configDir,
|
||||
}
|
||||
r.registry.Extensions = make(map[string]*RegistryEntry)
|
||||
|
||||
r.ensureConfigDir()
|
||||
|
||||
if err := r.loadRegistry(); err != nil {
|
||||
if Debug {
|
||||
fmt.Printf("Warning: could not load extension registry: %v\n", err)
|
||||
}
|
||||
}
|
||||
|
||||
return r
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) ensureConfigDir() error {
|
||||
extDir := filepath.Join(r.configDir, "extensions")
|
||||
return os.MkdirAll(extDir, 0755)
|
||||
}
|
||||
|
||||
// Update the Register method in extension_registry.go
|
||||
|
||||
func (r *ExtensionRegistry) Register(configPath string) error {
|
||||
// Read and parse the extension definition to verify it
|
||||
data, err := os.ReadFile(configPath)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to read config file: %w", err)
|
||||
}
|
||||
|
||||
var ext ExtensionDefinition
|
||||
if err := yaml.Unmarshal(data, &ext); err != nil {
|
||||
return fmt.Errorf("failed to parse config file: %w", err)
|
||||
}
|
||||
|
||||
// Validate extension name
|
||||
if ext.Name == "" {
|
||||
return fmt.Errorf("extension name cannot be empty")
|
||||
}
|
||||
|
||||
if strings.Contains(ext.Name, " ") {
|
||||
return fmt.Errorf("extension name '%s' contains spaces - names must not contain spaces", ext.Name)
|
||||
}
|
||||
|
||||
// Verify executable exists
|
||||
if _, err := os.Stat(ext.Executable); err != nil {
|
||||
return fmt.Errorf("executable not found: %w", err)
|
||||
}
|
||||
|
||||
// Get absolute path to config
|
||||
absPath, err := filepath.Abs(configPath)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get absolute path: %w", err)
|
||||
}
|
||||
|
||||
// Calculate hashes
|
||||
configHash := ComputeStringHash(string(data))
|
||||
executableHash, err := ComputeHash(ext.Executable)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to hash executable: %w", err)
|
||||
}
|
||||
|
||||
// Store entry
|
||||
r.registry.Extensions[ext.Name] = &RegistryEntry{
|
||||
ConfigPath: absPath,
|
||||
ConfigHash: configHash,
|
||||
ExecutableHash: executableHash,
|
||||
}
|
||||
|
||||
return r.saveRegistry()
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) validateExtensionDefinition(ext *ExtensionDefinition) error {
|
||||
// Validate required fields
|
||||
if ext.Name == "" {
|
||||
return fmt.Errorf("extension name is required")
|
||||
}
|
||||
if ext.Executable == "" {
|
||||
return fmt.Errorf("executable path is required")
|
||||
}
|
||||
if ext.Type == "" {
|
||||
return fmt.Errorf("extension type is required")
|
||||
}
|
||||
|
||||
// Validate timeout format
|
||||
if ext.Timeout != "" {
|
||||
if _, err := time.ParseDuration(ext.Timeout); err != nil {
|
||||
return fmt.Errorf("invalid timeout format: %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
// Validate operations
|
||||
if len(ext.Operations) == 0 {
|
||||
return fmt.Errorf("at least one operation must be defined")
|
||||
}
|
||||
for name, op := range ext.Operations {
|
||||
if op.CmdTemplate == "" {
|
||||
return fmt.Errorf("command template is required for operation %s", name)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) Remove(name string) error {
|
||||
if _, exists := r.registry.Extensions[name]; !exists {
|
||||
return fmt.Errorf("extension %s not found", name)
|
||||
}
|
||||
|
||||
delete(r.registry.Extensions, name)
|
||||
|
||||
return r.saveRegistry()
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) Verify(name string) error {
|
||||
// Get the registry entry
|
||||
entry, exists := r.registry.Extensions[name]
|
||||
if !exists {
|
||||
return fmt.Errorf("extension %s not found", name)
|
||||
}
|
||||
|
||||
// Load and parse the config file
|
||||
data, err := os.ReadFile(entry.ConfigPath)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to read config file: %w", err)
|
||||
}
|
||||
|
||||
// Verify config hash
|
||||
currentConfigHash := ComputeStringHash(string(data))
|
||||
if currentConfigHash != entry.ConfigHash {
|
||||
return fmt.Errorf("config file hash mismatch for %s", name)
|
||||
}
|
||||
|
||||
// Parse to get executable path
|
||||
var ext ExtensionDefinition
|
||||
if err := yaml.Unmarshal(data, &ext); err != nil {
|
||||
return fmt.Errorf("failed to parse config file: %w", err)
|
||||
}
|
||||
|
||||
// Verify executable hash
|
||||
currentExecutableHash, err := ComputeHash(ext.Executable)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to verify executable: %w", err)
|
||||
}
|
||||
|
||||
if currentExecutableHash != entry.ExecutableHash {
|
||||
return fmt.Errorf("executable hash mismatch for %s", name)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) GetExtension(name string) (*ExtensionDefinition, error) {
|
||||
entry, exists := r.registry.Extensions[name]
|
||||
if !exists {
|
||||
return nil, fmt.Errorf("extension %s not found", name)
|
||||
}
|
||||
|
||||
// Read current config file
|
||||
data, err := os.ReadFile(entry.ConfigPath)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to read config file: %w", err)
|
||||
}
|
||||
|
||||
// Verify config hash
|
||||
currentHash := ComputeStringHash(string(data))
|
||||
if currentHash != entry.ConfigHash {
|
||||
return nil, fmt.Errorf("config file hash mismatch for %s", name)
|
||||
}
|
||||
|
||||
// Parse config
|
||||
var ext ExtensionDefinition
|
||||
if err := yaml.Unmarshal(data, &ext); err != nil {
|
||||
return nil, fmt.Errorf("failed to parse config file: %w", err)
|
||||
}
|
||||
|
||||
// Verify executable hash
|
||||
currentExecHash, err := ComputeHash(ext.Executable)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to verify executable: %w", err)
|
||||
}
|
||||
|
||||
if currentExecHash != entry.ExecutableHash {
|
||||
return nil, fmt.Errorf("executable hash mismatch for %s", name)
|
||||
}
|
||||
|
||||
return &ext, nil
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) ListExtensions() ([]*ExtensionDefinition, error) {
|
||||
var exts []*ExtensionDefinition
|
||||
|
||||
for name := range r.registry.Extensions {
|
||||
ext, err := r.GetExtension(name)
|
||||
if err != nil {
|
||||
// Instead of failing, we'll return nil for this extension
|
||||
// The manager will handle displaying the error
|
||||
exts = append(exts, nil)
|
||||
continue
|
||||
}
|
||||
exts = append(exts, ext)
|
||||
}
|
||||
|
||||
return exts, nil
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) calculateFileHash(path string) (string, error) {
|
||||
f, err := os.Open(path)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
defer f.Close()
|
||||
|
||||
h := sha256.New()
|
||||
if _, err := io.Copy(h, f); err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
return hex.EncodeToString(h.Sum(nil)), nil
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) saveRegistry() error {
|
||||
data, err := yaml.Marshal(r.registry)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to marshal extension registry: %w", err)
|
||||
}
|
||||
|
||||
registryPath := filepath.Join(r.configDir, "extensions", "extensions.yaml")
|
||||
return os.WriteFile(registryPath, data, 0644)
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) loadRegistry() error {
|
||||
registryPath := filepath.Join(r.configDir, "extensions", "extensions.yaml")
|
||||
data, err := os.ReadFile(registryPath)
|
||||
if err != nil {
|
||||
if os.IsNotExist(err) {
|
||||
return nil // New registry
|
||||
}
|
||||
return fmt.Errorf("failed to read extension registry: %w", err)
|
||||
}
|
||||
|
||||
// Need to unmarshal the data into our registry
|
||||
if err := yaml.Unmarshal(data, &r.registry); err != nil {
|
||||
return fmt.Errorf("failed to parse extension registry: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
75
plugins/template/extension_registry_test.go
Normal file
75
plugins/template/extension_registry_test.go
Normal file
@@ -0,0 +1,75 @@
|
||||
package template
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestRegistryPersistence(t *testing.T) {
|
||||
tmpDir, err := os.MkdirTemp("", "fabric-ext-registry-persist-*")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp directory: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
// Create test executable
|
||||
execPath := filepath.Join(tmpDir, "test-exec.sh")
|
||||
execContent := []byte("#!/bin/bash\necho \"test\"")
|
||||
err = os.WriteFile(execPath, execContent, 0755)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create test executable: %v", err)
|
||||
}
|
||||
|
||||
// Create valid config
|
||||
configContent := `name: test-extension
|
||||
executable: ` + execPath + `
|
||||
type: executable
|
||||
timeout: 30s
|
||||
operations:
|
||||
test:
|
||||
cmd_template: "{{executable}} {{operation}}"`
|
||||
|
||||
configPath := filepath.Join(tmpDir, "test-extension.yaml")
|
||||
err = os.WriteFile(configPath, []byte(configContent), 0644)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create test config: %v", err)
|
||||
}
|
||||
|
||||
// Test registry persistence
|
||||
t.Run("SaveAndReload", func(t *testing.T) {
|
||||
// Create and populate first registry
|
||||
registry1 := NewExtensionRegistry(tmpDir)
|
||||
err := registry1.Register(configPath)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to register extension: %v", err)
|
||||
}
|
||||
|
||||
// Create new registry instance and verify it loads the saved state
|
||||
registry2 := NewExtensionRegistry(tmpDir)
|
||||
ext, err := registry2.GetExtension("test-extension")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get extension from reloaded registry: %v", err)
|
||||
}
|
||||
if ext.Name != "test-extension" {
|
||||
t.Errorf("Expected extension name 'test-extension', got %q", ext.Name)
|
||||
}
|
||||
})
|
||||
|
||||
// Test hash verification
|
||||
t.Run("HashVerification", func(t *testing.T) {
|
||||
registry := NewExtensionRegistry(tmpDir)
|
||||
|
||||
// Modify executable after registration
|
||||
modifiedExecContent := []byte("#!/bin/bash\necho \"modified\"")
|
||||
err := os.WriteFile(execPath, modifiedExecContent, 0755)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to modify executable: %v", err)
|
||||
}
|
||||
|
||||
_, err = registry.GetExtension("test-extension")
|
||||
if err == nil {
|
||||
t.Error("Expected error when executable modified, got nil")
|
||||
}
|
||||
})
|
||||
}
|
||||
33
plugins/template/hash.go
Normal file
33
plugins/template/hash.go
Normal file
@@ -0,0 +1,33 @@
|
||||
package template
|
||||
|
||||
import (
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
)
|
||||
|
||||
// ComputeHash computes SHA-256 hash of a file at given path.
|
||||
// Returns the hex-encoded hash string or an error if the operation fails.
|
||||
func ComputeHash(path string) (string, error) {
|
||||
f, err := os.Open(path)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("open file: %w", err)
|
||||
}
|
||||
defer f.Close()
|
||||
|
||||
h := sha256.New()
|
||||
if _, err := io.Copy(h, f); err != nil {
|
||||
return "", fmt.Errorf("read file: %w", err)
|
||||
}
|
||||
|
||||
return hex.EncodeToString(h.Sum(nil)), nil
|
||||
}
|
||||
|
||||
// ComputeStringHash returns hex-encoded SHA-256 hash of the given string
|
||||
func ComputeStringHash(s string) string {
|
||||
h := sha256.New()
|
||||
h.Write([]byte(s))
|
||||
return hex.EncodeToString(h.Sum(nil))
|
||||
}
|
||||
119
plugins/template/hash_test.go
Normal file
119
plugins/template/hash_test.go
Normal file
@@ -0,0 +1,119 @@
|
||||
// template/hash_test.go
|
||||
package template
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestComputeHash(t *testing.T) {
|
||||
// Create a temporary test file
|
||||
content := []byte("test content for hashing")
|
||||
tmpfile, err := os.CreateTemp("", "hashtest")
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create temp file: %v", err)
|
||||
}
|
||||
defer os.Remove(tmpfile.Name())
|
||||
|
||||
if _, err := tmpfile.Write(content); err != nil {
|
||||
t.Fatalf("failed to write to temp file: %v", err)
|
||||
}
|
||||
if err := tmpfile.Close(); err != nil {
|
||||
t.Fatalf("failed to close temp file: %v", err)
|
||||
}
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
path string
|
||||
want string // known hash for test content
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "valid file",
|
||||
path: tmpfile.Name(),
|
||||
want: "e25dd806d495b413931f4eea50b677a7a5c02d00460924661283f211a37f7e7f", // pre-computed hash of "test content for hashing"
|
||||
wantErr: false,
|
||||
},
|
||||
{
|
||||
name: "nonexistent file",
|
||||
path: filepath.Join(os.TempDir(), "nonexistent"),
|
||||
want: "",
|
||||
wantErr: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := ComputeHash(tt.path)
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("ComputeHash() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
if got != tt.want && !tt.wantErr {
|
||||
t.Errorf("ComputeHash() = %v, want %v", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestComputeStringHash(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
input string
|
||||
want string
|
||||
}{
|
||||
{
|
||||
name: "empty string",
|
||||
input: "",
|
||||
want: "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
|
||||
},
|
||||
{
|
||||
name: "simple string",
|
||||
input: "test",
|
||||
want: "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
|
||||
},
|
||||
{
|
||||
name: "longer string with spaces",
|
||||
input: "this is a test string",
|
||||
want: "f6774519d1c7a3389ef327e9c04766b999db8cdfb85d1346c471ee86d65885bc",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
if got := ComputeStringHash(tt.input); got != tt.want {
|
||||
t.Errorf("ComputeStringHash() = %v, want %v", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestHashConsistency ensures both hash functions produce same results for same content
|
||||
func TestHashConsistency(t *testing.T) {
|
||||
content := "test content for consistency check"
|
||||
|
||||
// Create a file with the test content
|
||||
tmpfile, err := os.CreateTemp("", "hashconsistency")
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create temp file: %v", err)
|
||||
}
|
||||
defer os.Remove(tmpfile.Name())
|
||||
|
||||
if err := os.WriteFile(tmpfile.Name(), []byte(content), 0644); err != nil {
|
||||
t.Fatalf("failed to write to temp file: %v", err)
|
||||
}
|
||||
|
||||
// Get hashes using both methods
|
||||
fileHash, err := ComputeHash(tmpfile.Name())
|
||||
if err != nil {
|
||||
t.Fatalf("ComputeHash failed: %v", err)
|
||||
}
|
||||
|
||||
stringHash := ComputeStringHash(content)
|
||||
|
||||
// Compare results
|
||||
if fileHash != stringHash {
|
||||
t.Errorf("Hash inconsistency: file hash %v != string hash %v", fileHash, stringHash)
|
||||
}
|
||||
}
|
||||
@@ -2,6 +2,8 @@ package template
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
"strings"
|
||||
)
|
||||
@@ -15,7 +17,20 @@ var (
|
||||
Debug = false // Debug flag
|
||||
)
|
||||
|
||||
var extensionManager *ExtensionManager
|
||||
|
||||
func init() {
|
||||
homedir, err := os.UserHomeDir()
|
||||
if err != nil {
|
||||
debugf("Warning: could not initialize extension manager: %v\n", err)
|
||||
}
|
||||
configDir := filepath.Join(homedir, ".config/fabric")
|
||||
extensionManager = NewExtensionManager(configDir)
|
||||
// Extensions will work if registry exists, otherwise they'll just fail gracefully
|
||||
}
|
||||
|
||||
var pluginPattern = regexp.MustCompile(`\{\{plugin:([^:]+):([^:]+)(?::([^}]+))?\}\}`)
|
||||
var extensionPattern = regexp.MustCompile(`\{\{ext:([^:]+):([^:]+)(?::([^}]+))?\}\}`)
|
||||
|
||||
func debugf(format string, a ...interface{}) {
|
||||
if Debug {
|
||||
@@ -24,9 +39,120 @@ func debugf(format string, a ...interface{}) {
|
||||
}
|
||||
|
||||
func ApplyTemplate(content string, variables map[string]string, input string) (string, error) {
|
||||
|
||||
var missingVars []string
|
||||
r := regexp.MustCompile(`\{\{([^{}]+)\}\}`)
|
||||
|
||||
debugf("Starting template processing\n")
|
||||
for strings.Contains(content, "{{") {
|
||||
matches := r.FindAllStringSubmatch(content, -1)
|
||||
if len(matches) == 0 {
|
||||
break
|
||||
}
|
||||
|
||||
replaced := false
|
||||
for _, match := range matches {
|
||||
fullMatch := match[0]
|
||||
varName := match[1]
|
||||
|
||||
// Check if this is a plugin call
|
||||
if strings.HasPrefix(varName, "plugin:") {
|
||||
pluginMatches := pluginPattern.FindStringSubmatch(fullMatch)
|
||||
if len(pluginMatches) >= 3 {
|
||||
namespace := pluginMatches[1]
|
||||
operation := pluginMatches[2]
|
||||
value := ""
|
||||
if len(pluginMatches) == 4 {
|
||||
value = pluginMatches[3]
|
||||
}
|
||||
|
||||
debugf("\nPlugin call:\n")
|
||||
debugf(" Namespace: %s\n", namespace)
|
||||
debugf(" Operation: %s\n", operation)
|
||||
debugf(" Value: %s\n", value)
|
||||
|
||||
var result string
|
||||
var err error
|
||||
|
||||
switch namespace {
|
||||
case "text":
|
||||
debugf("Executing text plugin\n")
|
||||
result, err = textPlugin.Apply(operation, value)
|
||||
case "datetime":
|
||||
debugf("Executing datetime plugin\n")
|
||||
result, err = datetimePlugin.Apply(operation, value)
|
||||
case "file":
|
||||
debugf("Executing file plugin\n")
|
||||
result, err = filePlugin.Apply(operation, value)
|
||||
debugf("File plugin result: %#v\n", result)
|
||||
case "fetch":
|
||||
debugf("Executing fetch plugin\n")
|
||||
result, err = fetchPlugin.Apply(operation, value)
|
||||
case "sys":
|
||||
debugf("Executing sys plugin\n")
|
||||
result, err = sysPlugin.Apply(operation, value)
|
||||
default:
|
||||
return "", fmt.Errorf("unknown plugin namespace: %s", namespace)
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
debugf("Plugin error: %v\n", err)
|
||||
return "", fmt.Errorf("plugin %s error: %v", namespace, err)
|
||||
}
|
||||
|
||||
debugf("Plugin result: %s\n", result)
|
||||
content = strings.ReplaceAll(content, fullMatch, result)
|
||||
debugf("Content after replacement: %s\n", content)
|
||||
continue
|
||||
}
|
||||
}
|
||||
|
||||
if pluginMatches := extensionPattern.FindStringSubmatch(fullMatch); len(pluginMatches) >= 3 {
|
||||
name := pluginMatches[1]
|
||||
operation := pluginMatches[2]
|
||||
value := ""
|
||||
if len(pluginMatches) == 4 {
|
||||
value = pluginMatches[3]
|
||||
}
|
||||
|
||||
debugf("\nExtension call:\n")
|
||||
debugf(" Name: %s\n", name)
|
||||
debugf(" Operation: %s\n", operation)
|
||||
debugf(" Value: %s\n", value)
|
||||
|
||||
result, err := extensionManager.ProcessExtension(name, operation, value)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("extension %s error: %v", name, err)
|
||||
}
|
||||
|
||||
content = strings.ReplaceAll(content, fullMatch, result)
|
||||
replaced = true
|
||||
continue
|
||||
}
|
||||
|
||||
// Handle regular variables and input
|
||||
debugf("Processing variable: %s\n", varName)
|
||||
if varName == "input" {
|
||||
debugf("Replacing {{input}}\n")
|
||||
replaced = true
|
||||
content = strings.ReplaceAll(content, fullMatch, input)
|
||||
} else {
|
||||
if val, ok := variables[varName]; !ok {
|
||||
debugf("Missing variable: %s\n", varName)
|
||||
missingVars = append(missingVars, varName)
|
||||
return "", fmt.Errorf("missing required variable: %s", varName)
|
||||
} else {
|
||||
debugf("Replacing variable %s with value: %s\n", varName, val)
|
||||
content = strings.ReplaceAll(content, fullMatch, val)
|
||||
replaced = true
|
||||
}
|
||||
}
|
||||
if !replaced {
|
||||
return "", fmt.Errorf("template processing stuck - potential infinite loop")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
debugf("Starting template processing\n")
|
||||
for strings.Contains(content, "{{") {
|
||||
matches := r.FindAllStringSubmatch(content, -1)
|
||||
|
||||
41
plugins/template/utils.go
Normal file
41
plugins/template/utils.go
Normal file
@@ -0,0 +1,41 @@
|
||||
// utils.go in template package for now
|
||||
package template
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"os/user"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// ExpandPath expands the ~ to user's home directory and returns absolute path
|
||||
// It also checks if the path exists
|
||||
// Returns expanded absolute path or error if:
|
||||
// - cannot determine user home directory
|
||||
// - cannot convert to absolute path
|
||||
// - path doesn't exist
|
||||
func ExpandPath(path string) (string, error) {
|
||||
// If path starts with ~
|
||||
if strings.HasPrefix(path, "~/") {
|
||||
usr, err := user.Current()
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to get user home directory: %w", err)
|
||||
}
|
||||
// Replace ~/ with actual home directory
|
||||
path = filepath.Join(usr.HomeDir, path[2:])
|
||||
}
|
||||
|
||||
// Convert to absolute path
|
||||
absPath, err := filepath.Abs(path)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to get absolute path: %w", err)
|
||||
}
|
||||
|
||||
// Check if path exists
|
||||
if _, err := os.Stat(absPath); err != nil {
|
||||
return "", fmt.Errorf("path does not exist: %w", err)
|
||||
}
|
||||
|
||||
return absPath, nil
|
||||
}
|
||||
@@ -238,6 +238,13 @@ func (o *YouTube) Grab(url string, options *Options) (ret *VideoInfo, err error)
|
||||
|
||||
ret = &VideoInfo{}
|
||||
|
||||
if options.Metadata {
|
||||
if ret.Metadata, err = o.GrabMetadata(videoId); err != nil {
|
||||
err = fmt.Errorf("error getting video metadata: %v", err)
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
if options.Duration {
|
||||
if ret.Duration, err = o.GrabDuration(videoId); err != nil {
|
||||
err = fmt.Errorf("error parsing video duration: %v", err)
|
||||
@@ -369,12 +376,61 @@ type Options struct {
|
||||
Transcript bool
|
||||
Comments bool
|
||||
Lang string
|
||||
Metadata bool
|
||||
}
|
||||
|
||||
type VideoInfo struct {
|
||||
Transcript string `json:"transcript"`
|
||||
Duration int `json:"duration"`
|
||||
Comments []string `json:"comments"`
|
||||
Transcript string `json:"transcript"`
|
||||
Duration int `json:"duration"`
|
||||
Comments []string `json:"comments"`
|
||||
Metadata *VideoMetadata `json:"metadata,omitempty"`
|
||||
}
|
||||
|
||||
type VideoMetadata struct {
|
||||
Id string `json:"id"`
|
||||
Title string `json:"title"`
|
||||
Description string `json:"description"`
|
||||
PublishedAt string `json:"publishedAt"`
|
||||
ChannelId string `json:"channelId"`
|
||||
ChannelTitle string `json:"channelTitle"`
|
||||
CategoryId string `json:"categoryId"`
|
||||
Tags []string `json:"tags"`
|
||||
ViewCount uint64 `json:"viewCount"`
|
||||
LikeCount uint64 `json:"likeCount"`
|
||||
}
|
||||
|
||||
func (o *YouTube) GrabMetadata(videoId string) (metadata *VideoMetadata, err error) {
|
||||
if err = o.initService(); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
call := o.service.Videos.List([]string{"snippet", "statistics"}).Id(videoId)
|
||||
var response *youtube.VideoListResponse
|
||||
if response, err = call.Do(); err != nil {
|
||||
return nil, fmt.Errorf("error getting video metadata: %v", err)
|
||||
}
|
||||
|
||||
if len(response.Items) == 0 {
|
||||
return nil, fmt.Errorf("no video found with ID: %s", videoId)
|
||||
}
|
||||
|
||||
video := response.Items[0]
|
||||
viewCount := video.Statistics.ViewCount
|
||||
likeCount := video.Statistics.LikeCount
|
||||
|
||||
metadata = &VideoMetadata{
|
||||
Id: video.Id,
|
||||
Title: video.Snippet.Title,
|
||||
Description: video.Snippet.Description,
|
||||
PublishedAt: video.Snippet.PublishedAt,
|
||||
ChannelId: video.Snippet.ChannelId,
|
||||
ChannelTitle: video.Snippet.ChannelTitle,
|
||||
CategoryId: video.Snippet.CategoryId,
|
||||
Tags: video.Snippet.Tags,
|
||||
ViewCount: viewCount,
|
||||
LikeCount: likeCount,
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
func (o *YouTube) GrabByFlags() (ret *VideoInfo, err error) {
|
||||
@@ -383,6 +439,7 @@ func (o *YouTube) GrabByFlags() (ret *VideoInfo, err error) {
|
||||
flag.BoolVar(&options.Transcript, "transcript", false, "Output only the transcript")
|
||||
flag.BoolVar(&options.Comments, "comments", false, "Output the comments on the video")
|
||||
flag.StringVar(&options.Lang, "lang", "en", "Language for the transcript (default: English)")
|
||||
flag.BoolVar(&options.Metadata, "metadata", false, "Output video metadata")
|
||||
flag.Parse()
|
||||
|
||||
if flag.NArg() == 0 {
|
||||
|
||||
1737
streamlit.py
Normal file
1737
streamlit.py
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1,3 +1,3 @@
|
||||
package main
|
||||
|
||||
var version = "v1.4.126"
|
||||
var version = "v1.4.129"
|
||||
|
||||
Reference in New Issue
Block a user