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

Update README.md

Browse Source
This commit is contained in:
Daniel Miessler 2024-02-16 15:56:23 -08:00 committed by GitHub
parent a619b3a944
commit 174df45cdf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -162,24 +162,25 @@ curl -sSL https://install.python-poetry.org | python3 -
./setup.sh
```
6. Restart your shell
6. Restart your shell to reload everything.
7. Setup your `OPENAI_API_KEY`.
7. Set your `OPENAI_API_KEY`.
```bash
export OPENAI_API_KEY=foobar
fabric --setup
```
8. Check if all command line applications can execute
You'll be asked to enter your OpenAI API key, which will be written to `~/.config/fabric/.env`. Patterns will then be downloaded from Github, which will take a few moments.
8. Now you are up and running! You can test by pulling the help.
```bash
# Make sure you can
# Making sure the paths are set up correctly
fabric --help
fabric-api
fabric-webui
```
PS: If you're using the `server` functions, `fabric-api` and `fabric-webui` need to be run in dictinct terminal windows.
> [!NOTE]
> If you're using the `server` functions, `fabric-api` and `fabric-webui` need to be run in distinct terminal windows.
### Using the `fabric` client
@ -211,14 +212,6 @@ options:
--setup Set up your fabric instance
```
2. Set up the client
```bash
fabric --setup
```
You'll be asked to enter your OpenAI API key, which will be written to `~/.config/fabric/.env`. Patterns will then be downloaded from Github, which will take a few moments.
#### Example commands
The client, by default, runs Fabric patterns without needing a server (the Patterns were downloaded during setup). This means the client connects directly to OpenAI using the input given and the Fabric pattern used.