Skip to content

Commit

Permalink
fix: #986 implement --version flag
Browse files Browse the repository at this point in the history
  • Loading branch information
eugeis committed Sep 26, 2024
1 parent ea323c1 commit 8f7acac
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 28 deletions.
28 changes: 4 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Then [set your environmental variables](#environmental-variables) as shown above

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
go install -ldflags "-X main.version=$(git describe --tags --always)" github.com/danielmiessler/fabric@latest
```

## Usage
Expand Down Expand Up @@ -211,14 +211,14 @@ Application Options:
-o, --output= Output to file
-n, --latest= Number of latest patterns to list (default: 0)
-d, --changeDefaultModel Change default model
-y, --youtube= YouTube video url to grab transcript, comments from it and send to chat
--transcript Grab transcript from YouTube video and send to chat
-y, --youtube= YouTube video "URL" to grab transcript, comments from it and send to chat
--transcript Grab transcript from YouTube video and send to chat (it used per default).
--comments Grab comments from YouTube video and send to chat
--dry-run Show what would be sent to the model without actually sending it
-g, --language= Specify the Language Code for the chat, e.g. -g=en -g=zh
-u, --scrape_url= Scrape website URL to markdown using Jina AI
-q, --scrape_question= Search question using Jina AI
-e, --seed= Seed to be used for LMM generation
--dry-run Show what would be sent to the model without actually sending it

Help Options:
-h, --help Show this help message
Expand Down Expand Up @@ -303,26 +303,6 @@ This feature works with all openai and ollama models but does NOT work with clau

Fabric also makes use of some core helper apps (tools) to make it easier to integrate with your various workflows. Here are some examples:

`yt` is a helper command that extracts the transcript from a YouTube video. You can use it like this:
```bash
yt https://www.youtube.com/watch?v=lQVcbY52_gY
```

This will return the transcript from the video, which you can then pipe into Fabric like this:
```bash
yt https://www.youtube.com/watch?v=lQVcbY52_gY | fabric --pattern extract_wisdom
```

### `yt` Installation

To install `yt`, install it the same way as you install Fabric, just with a different repo name.

```bash
go install github.com/danielmiessler/yt@latest
```

Be sure to add your `YOUTUBE_API_KEY` to `~/.config/fabric/.env`.

### `to_pdf`

`to_pdf` is a helper command that converts LaTeX files to PDF format. You can use it like this:
Expand Down
2 changes: 1 addition & 1 deletion cli/cli_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
)

func TestCli(t *testing.T) {
message, err := Cli()
message, err := Cli("test")
assert.NoError(t, err)
assert.Empty(t, message)
}
Expand Down
6 changes: 3 additions & 3 deletions cli/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@ type Flags struct {
Output string `short:"o" long:"output" description:"Output to file" default:""`
LatestPatterns string `short:"n" long:"latest" description:"Number of latest patterns to list" default:"0"`
ChangeDefaultModel bool `short:"d" long:"changeDefaultModel" description:"Change default model"`
YouTube string `short:"y" long:"youtube" description:"YouTube video url to grab transcript, comments from it and send to chat"`
YouTubeTranscript bool `long:"transcript" description:"Grab transcript from YouTube video and send to chat"`
YouTube string `short:"y" long:"youtube" description:"YouTube video \"URL\" to grab transcript, comments from it and send to chat"`
YouTubeTranscript bool `long:"transcript" description:"Grab transcript from YouTube video and send to chat (it used per default)."`
YouTubeComments bool `long:"comments" description:"Grab comments from YouTube video and send to chat"`
DryRun bool `long:"dry-run" description:"Show what would be sent to the model without actually sending it"`
Language string `short:"g" long:"language" description:"Specify the Language Code for the chat, e.g. -g=en -g=zh" default:""`
ScrapeURL string `short:"u" long:"scrape_url" description:"Scrape website URL to markdown using Jina AI"`
ScrapeQuestion string `short:"q" long:"scrape_question" description:"Search question using Jina AI"`
Seed int `short:"e" long:"seed" description:"Seed to be used for LMM generation"`
Version bool `long:"version" description:"Print current version"`
DryRun bool `long:"dry-run" description:"Show what would be sent to the model without actually sending it"`
}

// Init Initialize flags. returns a Flags struct and an error
Expand Down

0 comments on commit 8f7acac

Please sign in to comment.