Skip to content

Latest commit

 

History

History
159 lines (85 loc) · 3.16 KB

jtag.rdoc

File metadata and controls

159 lines (85 loc) · 3.16 KB

jtag - Autotagging for Jekyll

v0.1.2

Global Options

-d|–debug debug_level

Debug level

Default Value

0

–help

Show this message

-s|–silent

Run silently

Test (Dry run, don’t update files)

Run all commands and show results on the command line, but don’t overwrite/update any files

–version

Display the program version

Commands

Command: add tags to add from_post_file_or_pattern

Add tags to post

Options
-f|–format output_format

Format to use when outputting tags to console: list, csv or yaml

Default Value

yaml

Must Match

(?-mix:^(csv|list|yaml)$)

Command: blacklist tag [tag2...]

Blacklist a specific tag

Options
-r|–remove

Remove (unblacklist) the arguments

Command: config

Update and notify user of configuration files location

Options
-r|–reset

Reset all configuration files to default values

Command: find keyword[, keyword]*

List tags, optionally filter for keywords/regular expressions (OR)

This command can be used to find the exact format for a given tag to keep spaces, underscores, capitalization and pluralization consistent

Options
-f|–format output_format

Format to use when outputting tags to console: list, csv or yaml. Defaults to yaml.

Default Value

yaml

Must Match

(?-mix:^(csv|list|yaml)$)

-c|–counts

Include tag counts

Command: help command

Shows a list of commands or help for one command

Gets help for the application or its commands. Can also list the commands in a way helpful to creating a bash-style completion function

Options

List commands one per line, to assist with shell completion

Command: merge tags to merge merge_tag

Merge multiple tags into one

Scans the specified posts for any of the tags, merging any found into the last one in the list

Options
-f|–format output_format

Format to use when outputting tags to console: list, csv or yaml

Default Value

yaml

Must Match

(?-mix:^(csv|list|yaml)$)

Command: remove tags to remove from_post_file_or_pattern

Remove tags from a post

Options
-f|–format output_format

Format to use when outputting tags to console: list, csv or yaml

Default Value

yaml

Must Match

(?-mix:^(csv|list|yaml)$)

Command: sort filenames[, filenames]*

Sort the existing tags for posts

Options
-f|–format output_format

Format to use when outputting tags to console: list, csv or yaml

Default Value

yaml

Must Match

(?-mix:^(csv|list|yaml)$)

Command: tag filename[, filename]*

Generate a list of recommended tags, optionally updating the file

Options
-f|–format output_format

Format to use when outputting tags to console: list, csv or yaml

Default Value

yaml

Must Match

(?-mix:^(csv|list|yaml)$)

Command: tags filenames[, filenames]*

Show the current tags for posts

Options
-f|–format output_format

Format to use when outputting tags to console: list, csv or yaml

Default Value

yaml

Must Match

(?-mix:^(csv|list|yaml)$)