updated readme
This commit is contained in:
parent
fda9e9866d
commit
d7ca76cc5c
64
README.md
64
README.md
@ -209,38 +209,8 @@ Once you have it all set up, here's how to use it.
|
|||||||
`fabric -h`
|
`fabric -h`
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
us the results in
|
usage: fabric [-h] [--text TEXT] [--copy] [--agents {trip_planner,ApiKeys}] [--output [OUTPUT]] [--gui] [--stream] [--list] [--update] [--pattern PATTERN] [--setup] [--changeDefaultModel CHANGEDEFAULTMODEL]
|
||||||
realtime. NOTE: You will not be able to pipe the
|
[--model MODEL] [--listmodels] [--remoteOllamaServer REMOTEOLLAMASERVER] [--context]
|
||||||
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] [--remoteOllamaServer REMOTEOLLAMASERVER]
|
|
||||||
[--context]
|
|
||||||
|
|
||||||
An open source framework for augmenting humans using AI.
|
An open source framework for augmenting humans using AI.
|
||||||
|
|
||||||
@ -249,12 +219,24 @@ 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
|
--gui Use the GUI (Node and npm need to be installed)
|
||||||
|
--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
|
||||||
|
--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
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Example commands
|
#### Example commands
|
||||||
@ -536,7 +518,7 @@ windows:
|
|||||||
download instructions https://www.ffmpeg.org/download.html
|
download instructions https://www.ffmpeg.org/download.html
|
||||||
```
|
```
|
||||||
|
|
||||||
````bash
|
```bash
|
||||||
ts -h
|
ts -h
|
||||||
usage: ts [-h] audio_file
|
usage: ts [-h] audio_file
|
||||||
|
|
||||||
@ -547,17 +529,17 @@ positional arguments:
|
|||||||
|
|
||||||
options:
|
options:
|
||||||
-h, --help show this help message and exit
|
-h, --help show this help message and exit
|
||||||
````
|
```
|
||||||
|
|
||||||
## Save
|
## Save
|
||||||
|
|
||||||
`save` is a "tee-like" utility to pipeline saving of content, while keeping the output stream intact. Can optionally generate "frontmatter" for PKM utilities like Obsidian via the
|
`save` is a "tee-like" utility to pipeline saving of content, while keeping the output stream intact. Can optionally generate "frontmatter" for PKM utilities like Obsidian via the
|
||||||
"FABRIC_FRONTMATTER" environment variable
|
"FABRIC_FRONTMATTER" environment variable
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
If you'd like to default variables, set them in `~/.config/fabric/.env`. `FABRIC_OUTPUT_PATH` needs to be set so `save` where to write. `FABRIC_FRONTMATTER_TAGS` is optional, but useful for tracking how tags have entered your PKM, if that's important to you.
|
If you'd like to default variables, set them in `~/.config/fabric/.env`. `FABRIC_OUTPUT_PATH` needs to be set so `save` where to write. `FABRIC_FRONTMATTER_TAGS` is optional, but useful for tracking how tags have entered your PKM, if that's important to you.
|
||||||
|
|
||||||
### usage
|
### usage
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
usage: save [-h] [-t, TAG] [-n] [-s] [stub]
|
usage: save [-h] [-t, TAG] [-n] [-s] [stub]
|
||||||
|
|
||||||
@ -572,7 +554,7 @@ options:
|
|||||||
-t, TAG, --tag TAG add an additional frontmatter tag. Use this argument multiple timesfor multiple tags
|
-t, TAG, --tag TAG add an additional frontmatter tag. Use this argument multiple timesfor multiple tags
|
||||||
-n, --nofabric don't use the fabric tags, only use tags from --tag
|
-n, --nofabric don't use the fabric tags, only use tags from --tag
|
||||||
-s, --silent don't use STDOUT for output, only save to the file
|
-s, --silent don't use STDOUT for output, only save to the file
|
||||||
````
|
```
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
|
@ -28,7 +28,8 @@ def main():
|
|||||||
const="analyzepaper.txt",
|
const="analyzepaper.txt",
|
||||||
default=None,
|
default=None,
|
||||||
)
|
)
|
||||||
parser.add_argument("--gui", help="Use the GUI", action="store_true")
|
parser.add_argument(
|
||||||
|
"--gui", help="Use the GUI (Node and npm need to be installed)", action="store_true")
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--stream",
|
"--stream",
|
||||||
"-s",
|
"-s",
|
||||||
|
Loading…
x
Reference in New Issue
Block a user