Archives/fabric
2
0
Fork 0
mirror of https://github.com/danielmiessler/fabric synced 2024-11-08 07:11:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

changed readme

Browse Source
This commit is contained in:
Jonathan Dunn 2024-03-06 10:17:50 -05:00
parent 3869afd7cd
commit 063c3ca7f0
1 changed files with 19 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -197,8 +197,12 @@ Once you have it all set up, here's how to use it.
`fabric -h` `fabric -h`
```bash ```bash
fabric [-h] [--text TEXT] [--copy] [--agents {trip_planner,ApiKeys}] [--output [OUTPUT]] [--stream] [--list] [--update] [--pattern PATTERN] [--setup] [--changeDefaultModel CHANGEDEFAULTMODEL] [--local] fabric -h
[--claude] [--model MODEL] [--listmodels] [--context] usage: fabric [-h] [--text TEXT] [--copy] [--agents {trip_planner,ApiKeys}]
[--output [OUTPUT]] [--stream] [--list] [--update]
[--pattern PATTERN] [--setup]
[--changeDefaultModel CHANGEDEFAULTMODEL] [--local] [--claude]
[--model MODEL] [--listmodels] [--context]
An open source framework for augmenting humans using AI. An open source framework for augmenting humans using AI.
@ -207,23 +211,31 @@ options:
--text TEXT, -t TEXT Text to extract summary from --text TEXT, -t TEXT Text to extract summary from
--copy, -C Copy the response to the clipboard --copy, -C Copy the response to the clipboard
--agents {trip_planner,ApiKeys}, -a {trip_planner,ApiKeys} --agents {trip_planner,ApiKeys}, -a {trip_planner,ApiKeys}
Use an AI agent to help you with a task. Acceptable values are 'trip_planner' or 'ApiKeys'. This option cannot be used with any other flag. Use an AI agent to help you with a task. Acceptable
values are 'trip_planner' or 'ApiKeys'. This option
cannot be used with any other flag.
--output [OUTPUT], -o [OUTPUT] --output [OUTPUT], -o [OUTPUT]
Save the response to a file Save the response to a file
--stream, -s Use this option if you want to see the results in realtime. NOTE: You will not be able to pipe the output into another command. --stream, -s Use this option if you want to see the results in
realtime. NOTE: You will not be able to pipe the
output into another command.
--list, -l List available patterns --list, -l List available patterns
--update, -u Update patterns --update, -u Update patterns
--pattern PATTERN, -p PATTERN --pattern PATTERN, -p PATTERN
The pattern (prompt) to use The pattern (prompt) to use
--setup Set up your fabric instance --setup Set up your fabric instance
--changeDefaultModel CHANGEDEFAULTMODEL --changeDefaultModel CHANGEDEFAULTMODEL
Change the default model. Your choice will be saved in ~/.config/fabric/.env). For a list of available models, use the --listmodels flag. Change the default model. Your choice will be saved in
~/.config/fabric/.env). For a list of available
models, use the --listmodels flag.
--local, -L Use local LLM. Default is llama2 --local, -L Use local LLM. Default is llama2
--claude Use Claude AI --claude Use Claude AI
--model MODEL, -m MODEL --model MODEL, -m MODEL
Select the model to use (GPT-4 by default for chatGPT and llama2 for Ollama) Select the model to use (GPT-4 by default for chatGPT
and llama2 for Ollama)
--listmodels List all available models --listmodels List all available models
--context, -c Use Context file (context.md) to add context to your pattern --context, -c Use Context file (context.md) to add context to your
pattern
``` ```
#### Example commands #### Example commands