m3tam3re/fabric
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added migration and upgrade instructions.

Browse Source
This commit is contained in:
Daniel Miessler 2024-08-18 13:39:16 -07:00
parent 54e5076857
commit aeb5299054
1 changed files with 24 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -34,6 +34,8 @@
- [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)
- [Migrating](#Migrating)
- [Upgrading](#Upgrading)
- [Usage](#Usage) - [Usage](#Usage)
- [Examples](#examples) - [Examples](#examples)
- [Just use the Patterns](#just-use-the-patterns) - [Just use the Patterns](#just-use-the-patterns)
@ -93,13 +95,34 @@ 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](https://go.dev/doc/install), and then run the following command.
```bash ```bash
# Install Fabric directly from the repo # Install Fabric directly from the repo
go install github.com/danielmiessler/fabric@latest go install github.com/danielmiessler/fabric@latest
# Run the setup to set up your directories and keys # Run the setup to set up your directories and keys
fabric --setup fabric --setup
### Migration
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
# Uninstall Legacy Fabric
pipx uninstall fabric
# Clear any old Fabric aliases
(check your .bashrc, .zshrc, etc.)
# Install the Go version
go install github.com/danielmiessler/fabric@latest
# Run setup for the new version. Important because things have changed
fabric --setup
```
### Upgrading
The great thing about Go is that it's super easy to upgrade. Just run the same command you used to install it in the first place and you'll always get the latest version.
```bash
go install github.com/danielmiessler/fabric@latest
``` ```
## Usage ## Usage
@ -165,20 +188,6 @@ Application Options:
Help Options: Help Options:
-h, --help Show this help message -h, --help Show this help message
``` ```
## Migration from Legacy (Python) 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
# Uninstall Legacy Fabric
pipx uninstall fabric
# Clear any old Fabric aliases
(check your .bashrc, .zshrc, etc.)
# Install the Go version
go install github.com/danielmiessler/fabric@latest
# Run setup for the new version. Important because things have changed
fabric --setup
``` ```
## Our approach to prompting ## Our approach to prompting