fabric
is an open-source framework for augmenting humans using AI.fabric
's primary features is helping people collect and integrate prompts, which we call _Patterns_, into various parts of their lives.
Fabric has Patterns for all sorts of life and work activities, including:
- Extracting the most interesting parts of YouTube videos and podcasts
- Writing an essay in your own voice with just an idea as an input
- Summarizing opaque academic papers
- Creating perfectly matched AI art prompts for a piece of writing
- Rating the quality of content to see if you want to read/watch the whole thing
- Getting summaries of long, boring content
- Explaining code to you
- Turning bad documentation into usable documentation
- Create social media posts from any content input
- And a million more…
### Our approach to prompting
Fabric _Patterns_ are different than most prompts you'll see.
- **First, we use `Markdown` to help ensure maximum readability and editability**. This not only helps the creator make a good one, but also anyone who wants to deeply understand what it does. _Importantly, this also includes the AI you're sending it to!_
Here's an example of a Fabric Pattern.
```bash
https://github.com/danielmiessler/fabric/blob/main/patterns/extract_wisdom/system.md
```
- **Next, we are extremely clear in our instructions**, and we use the Markdown structure to emphasize what we want the AI to do, and in what order.
- **And finally, we tend to use the System section of the prompt almost exclusively**. In over a year of being heads-down with this stuff, we've just seen more efficacy from doing that. If that changes, or we're shown data that says otherwise, we will adjust.
## Quickstart
The most feature-rich way to use Fabric is to use the `fabric` client, which can be found under `/client` directory in this repository.
### Setting up the `fabric` client
Follow these steps to get the client installed and configured.
1. Navigate to where you want the Fabric project to live on your systemClone the directory to a semi-permanent place on your computer.
```bash
# Find a home for Fabric
cd /where/you/keep/code
```
2. Clone the project to your computer.
```bash
# Clone Fabric to your computer
git clone git@github.com:danielmiessler/fabric.git
```
3. Enter Fabric's /client directory
```bash
# Enter the project and its /client folder
cd fabric/client
```
4. Install the dependencies
```bash
# Install the pre-requisites
pip3 install -r requirements.txt
```
5. Add the path to the `fabric` client to your shell
```bash
# Tell your shell how to find the `fabric` client
echo 'alias fabric="/the/path/to/fabric/client" >> .bashrc'
# Example of ~/.zshrc or ~/.bashrc
alias fabric="~/Development/fabric/client/fabric"
```
6. Restart your shell
```bash
# Make sure you can
echo 'alias fabric="/the/path/to/fabric/client" >> .bashrc'
# Example
echo 'alias fabric="~/Development/fabric/client/fabric" >> .zshrc'
```
### Using the `fabric` client
Once you have it all set up, here's how to use it.
### 2. Just use the Patterns
If you're not looking to do anything fancy, and you just want a lot of great prompts, you can navigate to the [`/patterns`](https://github.com/danielmiessler/fabric/tree/main/patterns) directory and start exploring!
We hope that if you used nothing else from Fabric, the Patterns by themselves will make the project useful.
You can use any of the Patterns you see there in any AI application that you have, whether that's ChatGPT or some other app or website. Our plan and prediction is that people will soon be sharing many more than those we've published, and they will be way better than ours.
The wisdom of crowds for the win.
### 3. Create your own Fabric Mill (Server)