diff --git a/README.md b/README.md index bb966f0..f2908ec 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ ## Navigation -- [Introduction Video](#introduction-video) +- [Introduction Videos](#introduction-videos) - [What and Why](#what-and-why) - [Philosophy](#philosophy) - [Breaking problems into components](#breaking-problems-into-components) @@ -201,11 +201,38 @@ Once you have it all set up, here's how to use it. `fabric -h` ```bash -fabric [-h] [--text TEXT] [--copy] [--agents {trip_planner,ApiKeys}] +us the results in + realtime. NOTE: You will not be able to pipe the + output into another command. + --list, -l List available patterns + --clear Clears your persistent model choice so that you can + once again use the --model flag + --update, -u Update patterns. NOTE: This will revert the default + model to gpt4-turbo. please run --changeDefaultModel + to once again set default model + --pattern PATTERN, -p PATTERN + The pattern (prompt) to use + --setup Set up your fabric instance + --changeDefaultModel CHANGEDEFAULTMODEL + Change the default model. For a list of available + models, use the --listmodels flag. + --model MODEL, -m MODEL + Select the model to use. NOTE: Will not work if you + have set a default model. please use --clear to clear + persistence before using this flag + --listmodels List all available models + --remoteOllamaServer REMOTEOLLAMASERVER + The URL of the remote ollamaserver to use. ONLY USE + THIS if you are using a local ollama server in an non- + deault location or port + --context, -c Use Context file (context.md) to add context to your + pattern +age: fabric [-h] [--text TEXT] [--copy] [--agents {trip_planner,ApiKeys}] [--output [OUTPUT]] [--stream] [--list] [--clear] [--update] [--pattern PATTERN] [--setup] [--changeDefaultModel CHANGEDEFAULTMODEL] [--model MODEL] - [--listmodels] [--context] + [--listmodels] [--remoteOllamaServer REMOTEOLLAMASERVER] + [--context] An open source framework for augmenting humans using AI. @@ -219,27 +246,7 @@ options: cannot be used with any other flag. --output [OUTPUT], -o [OUTPUT] 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. - --list, -l List available patterns - --clear Clears your persistent model choice so that you can - once again use the --model flag - --update, -u Update patterns - --pattern PATTERN, -p PATTERN - The pattern (prompt) to use - --setup Set up your fabric instance - --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. - --model MODEL, -m MODEL - Select the model to use. NOTE: Will not work if you - have set a default model. please use --clear to clear - persistence before using this flag - --listmodels List all available models - --context, -c Use Context file (context.md) to add context to your - pattern + --stream, -s Use this option if you want to see ``` #### Example commands