sparkle_appcast

NAME

sparkle_appcast -- A simple Sparkle appcast.xml tool

SYNOPSIS

sparkle_appcast COMMAND [OPTIONS...] [ARGS...]

DESCRIPTION

sparkle_appcast is a Ruby gem that provides a command line interface and a Ruby library to create and update appcast.xml for Sparkle.

sparkle_appcast command line interface takes next commands.

appcast [OPTIONS...] FILE_PATH

Create appcast.xml with an application archive at FILE_PATH. The application archive file must contain exact one application bundle.

  • --key=KEY

    Path to DSA private key file. Required.

  • --url=URL

    URL to the application archive file published. Required.

  • --release-note=RELEASE_NOTE

    Path to a release note text file in Markdown format. Required.

  • --output=OUTPUT

    Path to an output appcast.xml. Optional. Default to puts in the standard output.

  • --title=TITLE

    Title for the release note. Optional. Default to "{{Bundle Name}} {Bundle Short Version String}} ({{Bundle Version}})".

  • --publish-date=PUBLISH_DATE

    Publish date time in local timezone. Optional. Default to the creation time of the application archive file.

  • --channel-title=CHANNEL_TITLE

    Title of the channel. Optional. Default to "Change log".

  • --channel-description=CHANNEL_DESCRIPTION

    Description of the channel. Optional. Default to "The most recent changes.".

sign [OPTIONS...] [FILE_PATH]

Sign data at FILE_PATH or reading from the standard input with DSA_PRIVATE_KEY_PATH and print signature that can be used in appcast.xml. Use this for testing private key.

  • --key=KEY

    Path to DSA private key file. Required.

markdown [FILE_PATH]

Format Markdown text file at FILE_PATH or reading from the standard input in HTML. Use this for writing the release note.

USAGE

Use Ruby Gems to install sparkle_appcast.

gem install sparkle_appcast

Or use bundler, add next line to Gemfile in your project.

gem "sprkle_appcast"

SEE ALSO