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-13 15:02:01 -04:00
parent 8b4da91579
commit 2bd7cd88d5
1 changed files with 11 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -148,40 +148,35 @@ git clone https://github.com/danielmiessler/fabric.git
cd fabric cd fabric
``` ```
4. Ensure the `setup.sh` script is executable. If you're not sure, you can make it executable by running the following command: 4. install pipx:
Mac:
```bash ```bash
chmod +x setup.sh brew install pipx
``` ```
5. Install poetry Linux:
ref.: https://python-poetry.org/docs/#installing-with-the-official-installer
```bash ```bash
curl -sSL https://install.python-poetry.org | python3 - sudo apt intall pipx
``` ```
6. Run the `setup.sh`, which will do the following: 5. Install fabric
- Installs python dependencies.
- Creates aliases in your OS. It should update `~/.bashrc`, `/.zshrc`, and `~/.bash_profile` if they are present in your file system.
```bash ```bash
./setup.sh pipx install .
``` ```
7. Restart your shell to reload everything. 6. Run setup:
8. Set your `OPENAI_API_KEY`.
```bash ```bash
fabric --setup 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. 7. Restart your shell to reload everything.
9. Now you are up and running! You can test by pulling the help. 8. Now you are up and running! You can test by pulling the help.
```bash ```bash
# Making sure the paths are set up correctly # Making sure the paths are set up correctly