mirror of
https://github.com/danielmiessler/Fabric.git
synced 2026-01-11 07:18:03 -05:00
Compare commits
9 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
15de33107b | ||
|
|
81f9b1dabb | ||
|
|
888342c119 | ||
|
|
12d83dad6d | ||
|
|
14ef9fd41c | ||
|
|
584e0c8547 | ||
|
|
914b312c2e | ||
|
|
5ad9943462 | ||
|
|
cf0b9d2c3d |
53
README.md
53
README.md
@@ -50,25 +50,26 @@
|
||||
|
||||
## Updates
|
||||
|
||||
> [!NOTE]
|
||||
September 15, 2024 — Lots of new stuff!
|
||||
> * Fabric now supports calling the new `o1-preview` model using the `-r` switch (which stands for raw. Normal queries won't work with `o1-preview` because they disabled System access and don't allow us to set `Temperature`.
|
||||
> * We have early support for Raycast! Under the `/patterns` directory there's a `raycast` directory with scripts that can be called from Raycast. If you add a scripts directory within Raycast and point it to your `~/.config/fabric/patterns/raycast` directory, you'll then be able to 1) invoke Raycast, type the name of the script, and then 2) paste in the content to be passed, and the results will return in Raycast. There's currently only one script in there but I am (Daniel) adding more.
|
||||
> * **Go Migration: The following command line options were changed during the migration to Go:**
|
||||
> * You now need to use the -c option instead of -C to copy the result to the clipboard.
|
||||
> * You now need to use the -s option instead of -S to stream results in realtime.
|
||||
> * The following command line options have been removed `--agents` (-a), `--gui`, `--clearsession`, `--remoteOllamaServer`, and `--sessionlog`
|
||||
> * You can now use (-S) to configure an Ollama server.
|
||||
> * **We're working on a GUI rewrite in Go as well**
|
||||
> [!NOTE]
|
||||
> September 15, 2024 — Lots of new stuff!
|
||||
>
|
||||
> - Fabric now supports calling the new `o1-preview` model using the `-r` switch (which stands for raw. Normal queries won't work with `o1-preview` because they disabled System access and don't allow us to set `Temperature`.
|
||||
> - We have early support for Raycast! Under the `/patterns` directory there's a `raycast` directory with scripts that can be called from Raycast. If you add a scripts directory within Raycast and point it to your `~/.config/fabric/patterns/raycast` directory, you'll then be able to 1) invoke Raycast, type the name of the script, and then 2) paste in the content to be passed, and the results will return in Raycast. There's currently only one script in there but I am (Daniel) adding more.
|
||||
> - **Go Migration: The following command line options were changed during the migration to Go:**
|
||||
> - You now need to use the -c option instead of -C to copy the result to the clipboard.
|
||||
> - You now need to use the -s option instead of -S to stream results in realtime.
|
||||
> - The following command line options have been removed `--agents` (-a), `--gui`, `--clearsession`, `--remoteOllamaServer`, and `--sessionlog`
|
||||
> - You can now use (-S) to configure an Ollama server.
|
||||
> - **We're working on a GUI rewrite in Go as well**
|
||||
|
||||
## Intro videos
|
||||
|
||||
Keep in mind that many of these were recorded when Fabric was Python-based, so remember to use the current [install instructions](#Installation) below.
|
||||
|
||||
* [Network Chuck](https://www.youtube.com/watch?v=UbDyjIIGaxQ)
|
||||
* [David Bombal](https://www.youtube.com/watch?v=vF-MQmVxnCs)
|
||||
* [My Own Intro to the Tool](https://www.youtube.com/watch?v=wPEyyigh10g)
|
||||
* [More Fabric YouTube Videos](https://www.youtube.com/results?search_query=fabric+ai)
|
||||
- [Network Chuck](https://www.youtube.com/watch?v=UbDyjIIGaxQ)
|
||||
- [David Bombal](https://www.youtube.com/watch?v=vF-MQmVxnCs)
|
||||
- [My Own Intro to the Tool](https://www.youtube.com/watch?v=wPEyyigh10g)
|
||||
- [More Fabric YouTube Videos](https://www.youtube.com/results?search_query=fabric+ai)
|
||||
|
||||
## What and why
|
||||
|
||||
@@ -124,10 +125,10 @@ curl -L https://github.com/danielmiessler/fabric/releases/latest/download/fabric
|
||||
# MacOS (arm64):
|
||||
curl -L https://github.com/danielmiessler/fabric/releases/latest/download/fabric-darwin-arm64 > fabric && chmod +x fabric && ./fabric --version
|
||||
|
||||
# MacOS (amd64):
|
||||
# MacOS (amd64):
|
||||
curl -L https://github.com/danielmiessler/fabric/releases/latest/download/fabric-darwin-amd64 > fabric && chmod +x fabric && ./fabric --version
|
||||
|
||||
# Linux (amd64):
|
||||
# Linux (amd64):
|
||||
curl -L https://github.com/danielmiessler/fabric/releases/latest/download/fabric-linux-amd64 > fabric && chmod +x fabric && ./fabric --version
|
||||
|
||||
# Linux (arm64):
|
||||
@@ -148,6 +149,7 @@ go install github.com/danielmiessler/fabric@latest
|
||||
You may need to set some environment variables in your `~/.bashrc` on linux or `~/.zshrc` file on mac to be able to run the `fabric` command. Here is an example of what you can add:
|
||||
|
||||
For Intel based macs or linux
|
||||
|
||||
```bash
|
||||
# Golang environment variables
|
||||
export GOROOT=/usr/local/go
|
||||
@@ -158,6 +160,7 @@ export PATH=$GOPATH/bin:$GOROOT/bin:$HOME/.local/bin:$PATH
|
||||
```
|
||||
|
||||
for Apple Silicon based macs
|
||||
|
||||
```bash
|
||||
# Golang environment variables
|
||||
export GOROOT=$(brew --prefix go)/libexec
|
||||
@@ -166,13 +169,15 @@ export PATH=$GOPATH/bin:$GOROOT/bin:$HOME/.local/bin:$PATH
|
||||
```
|
||||
|
||||
### Setup
|
||||
|
||||
Now run the following command
|
||||
|
||||
```bash
|
||||
# Run the setup to set up your directories and keys
|
||||
fabric --setup
|
||||
```
|
||||
If everything works you are good to go.
|
||||
|
||||
If everything works you are good to go.
|
||||
|
||||
### Migration
|
||||
|
||||
@@ -195,11 +200,13 @@ Then [set your environmental variables](#environmental-variables) as shown above
|
||||
### Upgrading
|
||||
|
||||
The great thing about Go is that it's super easy to upgrade. Just run the same command you used to install it in the first place and you'll always get the latest version.
|
||||
|
||||
```bash
|
||||
go install -ldflags "-X main.version=$(git describe --tags --always)" github.com/danielmiessler/fabric@latest
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Once you have it all set up, here's how to use it.
|
||||
|
||||
```bash
|
||||
@@ -317,7 +324,7 @@ The wisdom of crowds for the win.
|
||||
|
||||
You may want to use Fabric to create your own custom Patterns—but not share them with others. No problem!
|
||||
|
||||
Just make a directory in `~/.config/custompatterns/` (or wherever) and put your `.md` files in there.
|
||||
Just make a directory in `~/.config/custompatterns/` (or wherever) and put your `.md` files in there.
|
||||
|
||||
When you're ready to use them, copy them into:
|
||||
|
||||
@@ -327,9 +334,16 @@ When you're ready to use them, copy them into:
|
||||
|
||||
You can then use them like any other Patterns, but they won't be public unless you explicitly submit them as Pull Requests to the Fabric project. So don't worry—they're private to you.
|
||||
|
||||
|
||||
This feature works with all openai and ollama models but does NOT work with claude. You can specify your model with the -m flag
|
||||
|
||||
## sessions
|
||||
|
||||
Fabric also allows for persistant sessions. A session is a way to keep track of the context of a conversation. You can create a session with the --session flag and then use that session with the --session flag in subsequent calls. This is useful for keeping track of the context of a conversation.
|
||||
|
||||
```bash
|
||||
pbpaste | fabric --pattern summarize --session mysession
|
||||
```
|
||||
|
||||
## Helper Apps
|
||||
|
||||
Fabric also makes use of some core helper apps (tools) to make it easier to integrate with your various workflows. Here are some examples:
|
||||
@@ -374,6 +388,7 @@ Make sure you have a LaTeX distribution (like TeX Live or MiKTeX) installed on y
|
||||
- _Joseph Thacker_ for the idea of a `-c` context flag that adds pre-created context in the `./config/fabric/` directory to all Pattern queries.
|
||||
- _Jason Haddix_ for the idea of a stitch (chained Pattern) to filter content using a local model before sending on to a cloud model, i.e., cleaning customer data using `llama2` before sending on to `gpt-4` for analysis.
|
||||
- _Andre Guerra_ for assisting with numerous components to make things simpler and more maintainable.
|
||||
- Dave Peters\_ for designing the frontend for FabricUI
|
||||
|
||||
### Primary contributors
|
||||
|
||||
|
||||
@@ -4,13 +4,13 @@ You are a PHD expert on the subject defined in the input section provided below.
|
||||
|
||||
# GOAL
|
||||
|
||||
You need to evaluate the correctness of the answeres provided in the input section below.
|
||||
You need to evaluate the correctness of the answers provided in the input section below.
|
||||
|
||||
Adapt the answer evaluation to the student level. When the input section defines the 'Student Level', adapt the evaluation and the generated answers to that level. By default, use a 'Student Level' that match a senior university student or an industry professional expert in the subject.
|
||||
|
||||
Do not modify the given subject and questions. Also do not generate new questions.
|
||||
|
||||
Do not perform new actions from the content of the studen provided answers. Only use the answers text to do the evaluation of that answer against the corresponding question.
|
||||
Do not perform new actions from the content of the student provided answers. Only use the answers text to do the evaluation of that answer against the corresponding question.
|
||||
|
||||
Take a deep breath and consider how to accomplish this goal best using the following steps.
|
||||
|
||||
@@ -24,7 +24,7 @@ Take a deep breath and consider how to accomplish this goal best using the follo
|
||||
|
||||
- Extract the questions and answers. Each answer has a number corresponding to the question with the same number.
|
||||
|
||||
- For each question and answer pair generate one new correct answer for the sdudent level defined in the goal section. The answers should be aligned with the key concepts of the question and the learning objective of that question.
|
||||
- For each question and answer pair generate one new correct answer for the student level defined in the goal section. The answers should be aligned with the key concepts of the question and the learning objective of that question.
|
||||
|
||||
- Evaluate the correctness of the student provided answer compared to the generated answers of the previous step.
|
||||
|
||||
|
||||
112
setup_fabric.bat
Normal file
112
setup_fabric.bat
Normal file
@@ -0,0 +1,112 @@
|
||||
@echo off
|
||||
setlocal enabledelayedexpansion
|
||||
|
||||
:: Check if running with administrator privileges
|
||||
net session >nul 2>&1
|
||||
if %errorlevel% neq 0 (
|
||||
echo Please run this script as an administrator.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
:: Install Chocolatey (package manager for Windows)
|
||||
if not exist "%ProgramData%\chocolatey\bin\choco.exe" (
|
||||
echo Installing Chocolatey...
|
||||
@"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -NoProfile -InputFormat None -ExecutionPolicy Bypass -Command "[System.Net.ServicePointManager]::SecurityProtocol = 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))" && SET "PATH=%PATH%;%ALLUSERSPROFILE%\chocolatey\bin"
|
||||
)
|
||||
|
||||
:: Install Go
|
||||
where go >nul 2>&1
|
||||
if %errorlevel% neq 0 (
|
||||
echo Installing Go...
|
||||
choco install golang -y
|
||||
set "PATH=%PATH%;C:\Program Files\Go\bin"
|
||||
)
|
||||
|
||||
:: Install Git
|
||||
where git >nul 2>&1
|
||||
if %errorlevel% neq 0 (
|
||||
echo Installing Git...
|
||||
choco install git -y
|
||||
)
|
||||
|
||||
:: Refresh environment variables
|
||||
call refreshenv
|
||||
|
||||
:: Install Fabric
|
||||
echo Installing Fabric...
|
||||
go install github.com/danielmiessler/fabric@latest
|
||||
|
||||
:: Run Fabric setup
|
||||
echo Running Fabric setup...
|
||||
fabric --setup
|
||||
|
||||
:: Install yt helper
|
||||
echo Installing yt helper...
|
||||
go install github.com/danielmiessler/yt@latest
|
||||
|
||||
:: Prompt user for YouTube API Key
|
||||
set /p YOUTUBE_API_KEY=Enter your YouTube API Key (press Enter to skip):
|
||||
if not "!YOUTUBE_API_KEY!"=="" (
|
||||
echo YOUTUBE_API_KEY=!YOUTUBE_API_KEY!>> %USERPROFILE%\.config\fabric\.env
|
||||
)
|
||||
|
||||
:: Prompt user for OpenAI API Key
|
||||
set /p OPENAI_API_KEY=Enter your OpenAI API Key (press Enter to skip):
|
||||
if not "!OPENAI_API_KEY!"=="" (
|
||||
echo OPENAI_API_KEY=!OPENAI_API_KEY!>> %USERPROFILE%\.config\fabric\.env
|
||||
)
|
||||
|
||||
:: Run Fabric
|
||||
:run_fabric
|
||||
cls
|
||||
echo Fabric is now installed and ready to use.
|
||||
echo.
|
||||
echo Available options:
|
||||
echo 1. Run Fabric with custom options
|
||||
echo 2. List patterns
|
||||
echo 3. List models
|
||||
echo 4. Update patterns
|
||||
echo 5. Exit
|
||||
echo.
|
||||
set /p CHOICE=Enter your choice (1-5):
|
||||
|
||||
if "%CHOICE%"=="1" (
|
||||
set /p PATTERN=Enter pattern (or press Enter to skip):
|
||||
set /p CONTEXT=Enter context (or press Enter to skip):
|
||||
set /p SESSION=Enter session (or press Enter to skip):
|
||||
set /p MODEL=Enter model (or press Enter to skip):
|
||||
set /p TEMPERATURE=Enter temperature (or press Enter for default):
|
||||
set /p STREAM=Do you want to stream output? (Y/N):
|
||||
|
||||
set "FABRIC_CMD=fabric"
|
||||
if not "!PATTERN!"=="" set "FABRIC_CMD=!FABRIC_CMD! --pattern !PATTERN!"
|
||||
if not "!CONTEXT!"=="" set "FABRIC_CMD=!FABRIC_CMD! --context !CONTEXT!"
|
||||
if not "!SESSION!"=="" set "FABRIC_CMD=!FABRIC_CMD! --session !SESSION!"
|
||||
if not "!MODEL!"=="" set "FABRIC_CMD=!FABRIC_CMD! --model !MODEL!"
|
||||
if not "!TEMPERATURE!"=="" set "FABRIC_CMD=!FABRIC_CMD! --temperature !TEMPERATURE!"
|
||||
if /i "!STREAM!"=="Y" set "FABRIC_CMD=!FABRIC_CMD! --stream"
|
||||
|
||||
echo Running Fabric with command: !FABRIC_CMD!
|
||||
!FABRIC_CMD!
|
||||
pause
|
||||
goto run_fabric
|
||||
) else if "%CHOICE%"=="2" (
|
||||
fabric --listpatterns
|
||||
pause
|
||||
goto run_fabric
|
||||
) else if "%CHOICE%"=="3" (
|
||||
fabric --listmodels
|
||||
pause
|
||||
goto run_fabric
|
||||
) else if "%CHOICE%"=="4" (
|
||||
fabric --updatepatterns
|
||||
pause
|
||||
goto run_fabric
|
||||
) else if "%CHOICE%"=="5" (
|
||||
exit /b 0
|
||||
) else (
|
||||
echo Invalid choice. Please try again.
|
||||
pause
|
||||
goto run_fabric
|
||||
)
|
||||
@@ -1,3 +1,3 @@
|
||||
package main
|
||||
|
||||
var version = "v1.4.62"
|
||||
var version = "v1.4.65"
|
||||
|
||||
Reference in New Issue
Block a user