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:
Daniel Miessler 2024-08-16 14:07:33 -07:00
parent 312435bea2
commit 55fe665261
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -17,6 +17,7 @@
[What and Why](#whatandwhy) • [What and Why](#whatandwhy) •
[Philosophy](#philosophy) • [Philosophy](#philosophy) •
[Installation](#Installation) • [Installation](#Installation) •
[Usage](#Usage) •
[Examples](#examples) • [Examples](#examples) •
[Just Use the Patterns](#just-use-the-patterns) • [Just Use the Patterns](#just-use-the-patterns) •
[Custom Patterns](#custom-patterns) • [Custom Patterns](#custom-patterns) •
@ -33,6 +34,7 @@
- [Too many prompts](#too-many-prompts) - [Too many prompts](#too-many-prompts)
- [The Fabric approach to prompting](#our-approach-to-prompting) - [The Fabric approach to prompting](#our-approach-to-prompting)
- [Installation](#Installation) - [Installation](#Installation)
- [Usage](#Usage)
- [Examples](#examples) - [Examples](#examples)
- [Just use the Patterns](#just-use-the-patterns) - [Just use the Patterns](#just-use-the-patterns)
- [Custom Patterns](#custom-patterns) - [Custom Patterns](#custom-patterns)
@ -92,11 +94,15 @@ Fabric has Patterns for all sorts of life and work activities, including:
## Installation ## Installation
To install Fabric, make sure Go is installed, and then run the following command. To install Fabric, make sure Go is installed, and then run the following command.
```
go install github.com/danielmiessler/fabric@latest` in the main directory! ```bash
# Install Fabric directly from the repo
go install github.com/danielmiessler/fabric@latest
# Run the setup to set up your directories and keys
fabric --setup fabric --setup
``` ```
## Usage
Once you have it all set up, here's how to use it. Once you have it all set up, here's how to use it.
1. Check out the options 1. Check out the options
@ -164,14 +170,14 @@ Help Options:
If you have the Legacy (Python) version installed and want to migrate to the Go version, here's how you do it. It's basically two steps: 1) uninstall the Python version, and 2) install the Go version. If you have the Legacy (Python) version installed and want to migrate to the Go version, here's how you do it. It's basically two steps: 1) uninstall the Python version, and 2) install the Go version.
```bash ```bash
// Uninstall Legacy Fabric # Uninstall Legacy Fabric
pipx uninstall fabric pipx uninstall fabric
// Clear any old Fabric aliases # Clear any old Fabric aliases
(check your .bashrc, .zshrc, etc.) (check your .bashrc, .zshrc, etc.)
// Install the Go version # Install the Go version
go install github.com/danielmiessler/fabric@latest go install github.com/danielmiessler/fabric@latest
// Run setup for the new version. Important because things have changed # Run setup for the new version. Important because things have changed
fabric --setup fabric --setup
``` ```