Skip to content

Commit

Permalink
added short flags, updated readme
Browse files Browse the repository at this point in the history
Signed-off-by: gryffyn <[email protected]>
  • Loading branch information
gryffyn committed May 31, 2022
1 parent abf6232 commit 5f24e24
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ go build
## usage
```
Usage:
osiris [OPTIONS] [regex] [filename]
osiris [OPTIONS] [regex] [filename...]
Application Options:
-d, --dryrun don't modify files
-s, --silent don't print file names
--no-color disables colored output
-f, --film uses film output format
--year= release year override
--title= release title override
-y, --year= release year override
-t, --title= release title override
Help Options:
-h, --help Show this help message
Expand All @@ -48,7 +48,7 @@ the regex argument takes in a regex with specifically-named named capture groups

odin follows a standard-ish format, namely

`Series Title (YEAR) - S01E01 - Episode Title (SCENE INFO).ext`
`Series Title - S01E01 - Episode Title (SCENE INFO).ext`

or in the case of a film (`-f, --film`)

Expand All @@ -57,6 +57,6 @@ or in the case of a film (`-f, --film`)
## example

```shell
$ osiris -d --year=1997 '(?P<title>\w+)\.(?P<ep>S\d{2}E\d{2})\.(?P<eptitle>[\w\.]+)\.(?P<scene>WEB-.+)' Title.S01E01.Episode.Title.WEB-DL.H264.SCENE.mkv
Title.S01E01.Episode.Title.WEB-DL.H264.SCENE.mkv -> ./Title (1997) - S01E01 - Episode Title (WEB-DL H264 SCENE).mkv
$ osiris -d '(?P<title>\w+)\.(?P<ep>S\d{2}E\d{2})\.(?P<eptitle>[\w\.]+)\.(?P<scene>WEB-.+)' Title.S01E01.Episode.Title.WEB-DL.H264.SCENE.mkv
Title.S01E01.Episode.Title.WEB-DL.H264.SCENE.mkv -> ./Title - S01E01 - Episode Title (WEB-DL H264 SCENE).mkv
```
4 changes: 2 additions & 2 deletions osiris.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ type args struct {
Silent bool `short:"s" long:"silent" description:"don't print file names"`
NoColor bool `long:"no-color" description:"disables colored output"`
Film bool `short:"f" long:"film" description:"uses film output format"`
Year string `long:"year" description:"release year override"`
Title string `long:"title" description:"release title override"`
Year string `short:"y" long:"year" description:"release year override"`
Title string `short:"t" long:"title" description:"release title override"`
Positional struct {
Regex string `positional-arg-name:"regex" required:"true"`
Filename []string `positional-arg-name:"filename" required:"true"`
Expand Down

0 comments on commit 5f24e24

Please sign in to comment.