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

updated readme

Browse Source
This commit is contained in:
Jonathan Dunn 2024-03-05 15:29:46 -05:00
parent 38c09afc85
commit 39c4636148
2 changed files with 7 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -194,10 +194,8 @@ 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}] fabric [-h] [--text TEXT] [--copy] [--agents {trip_planner,ApiKeys}] [--output [OUTPUT]] [--stream] [--list] [--update] [--pattern PATTERN] [--setup] [--local] [--model MODEL] [--listmodels]
[--output [OUTPUT]] [--stream] [--list] [--update] [--context]
[--pattern PATTERN] [--setup] [--local] [--model MODEL]
[--listmodels] [--context]
An open source framework for augmenting humans using AI. An open source framework for augmenting humans using AI.
@ -206,14 +204,10 @@ 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 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.
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 --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.
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
@ -221,10 +215,9 @@ options:
--setup Set up your fabric instance --setup Set up your fabric instance
--local, -L Use local LLM. Default is llama2 --local, -L Use local LLM. Default is llama2
--model MODEL, -m MODEL --model MODEL, -m MODEL
Select the model to use (GPT-4 by default) 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 --context, -c Use Context file (context.md) to add context to your pattern
pattern
``` ```
#### Example commands #### Example commands

2
installer/client/cli/fabric.py
View File

@ -46,7 +46,7 @@ def main():
parser.add_argument( parser.add_argument(
'--local', '-L', help="Use local LLM. Default is llama2", action="store_true") '--local', '-L', help="Use local LLM. Default is llama2", action="store_true")
parser.add_argument( parser.add_argument(
"--model", "-m", help="Select the model to use (GPT-4 by default)", default="gpt-4-turbo-preview" "--model", "-m", help="Select the model to use (GPT-4 by default for chatGPT and llama2 for Ollama)", default="gpt-4-turbo-preview"
) )
parser.add_argument( parser.add_argument(
"--listmodels", help="List all available models", action="store_true" "--listmodels", help="List all available models", action="store_true"