CLI#

For each command the gray box shows the usage.

Note

These are documented according to bash/unix convention.

the [] do not get used, they indicate that there might be more than one item in that position
[OPTIONS] refers to any optional inputs or options
[ARGS] refers to required inputs, or arguments

urlfwd#

A set of tools to create a set of html redirect pages or QR codes from a yaml file

urlfwd [OPTIONS] COMMAND [ARGS]...

add#

add a new link with options or prompting

urlfwd add [OPTIONS]

Options

-u, --url <url>#: url to forward to

-l, --short-link <short_link>#: short name to create

-y, --yaml-file <yaml_file>#: file name if not links.yml

-f, --force#: force to overwrite an existing key

-b, --build#: also rebuild

-c, --commit#: commit and push the links file

config#

set up persistent project options

urlfwd config [OPTIONS] COMMAND [ARGS]...

create#

create a config file for the project

urlfwd config create [OPTIONS]

Options

--author <author>#: Author Name

--author-url <author_url>#: Author URL

--title <title>#: Title for index page

--index <index>#: Index prefix before autogen

--about <about>#: Description of the project for the index

--force#: Force overwrite existing config file

edit#

interactively edit an existing config file

urlfwd config edit [OPTIONS]

deploy#

set up github actions for deployment and/or adding links via form

urlfwd deploy [OPTIONS]

Options

--gh-deploy#: the project will be hosted with gh pages

--gh-form#: the project will have a github form to add links

--update#: reset existing files

--commit#: commit and push the changes

gen#

generate links or qrs

urlfwd gen [OPTIONS] COMMAND [ARGS]...

links#

from a yaml source file create a set of toy files with file names as the keys and the values as the content of each file

urlfwd gen links [OPTIONS]

Options

-s, --source-yaml <source_yaml>#: file name if not links.yml

-c, --config-yaml <config_yaml>#: configuration file name if not config.yml

-r, --retain#: retain existing (do not overwrite)

-p, --out-path <out_path>#: path to write files to default docs

-v, --verbose#: verbose mode, print details

-l, --landing#: create a landing page

-i, --index#: create a landing page, with index

qrs#

from a yaml source file create a set QR codes to each link and optionally a flyer page with a QR code and description of the link

urlfwd gen qrs [OPTIONS]

Options

-s, --source-yaml <source_yaml>#: file name if not links.yml

-c, --config-yaml <config_yaml>#: configuration file name if not config.yml

-r, --retain#: retain existing (do not overwrite)

-p, --out-path <out_path>#: path to write files to default docs/qr

-v, --verbose#: verbose mode, print details

-f, --flyer-pages#: create a flyer page for each qr code

-t, --flyer-template-input <flyer_template_input>#: template to use for flyers if generated

-d, --flyer-desc-template <flyer_desc_template>#: template to use for flyer descrition if detailed

-i, --index#: create a landing page, with index

init#

initialize the project with a default config and links file

urlfwd init [OPTIONS]

Options

--usegit#: the project will use git to track changes and push to remote

--gh-deploy#: the project will be hosted with gh pages

--gh-form#: the project will have a github form to add links

--reset#: reset existing files