diff --git a/CHANGELOG.md b/CHANGELOG.md index d152ed2b..9f54d5b2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY! This project adheres to [Semantic Versioning](http://semver.org/). +## v6.7.4 - 2017-10-25 + +* Add preload to the CLI docs #702 [Tim Perry] + ## v6.7.3 - 2017-10-25 * Allow specifying `--commit=latest` for `resin preload` #701 [Alexis Svinartchouk] diff --git a/capitanodoc.coffee b/capitanodoc.coffee index d21c665b..fde55050 100644 --- a/capitanodoc.coffee +++ b/capitanodoc.coffee @@ -85,6 +85,10 @@ module.exports = title: 'Config', files: [ 'lib/actions/config.coffee' ] }, + { + title: 'Preload', + files: [ 'lib/actions/preload.coffee' ] + }, { title: 'Settings', files: [ 'lib/actions/settings.coffee' ] diff --git a/doc/cli.markdown b/doc/cli.markdown index d07eeb10..578929ee 100644 --- a/doc/cli.markdown +++ b/doc/cli.markdown @@ -117,6 +117,10 @@ environment variable (in the same standard URL format). - [config reconfigure](#config-reconfigure) - [config generate](#config-generate) +- Preload + + - [preload <image>](#preload-60-image-62-) + - Settings - [settings](#settings) @@ -1066,6 +1070,69 @@ custom device key - note that this is only supported on ResinOS 2.0.3+ output +# Preload + +## preload <image> + +Warning: "resin preload" requires Docker to be correctly installed in +your shell environment. For more information (including Windows support) +please check the README here: https://github.com/resin-io/resin-cli . + +Use this command to preload an application to a local disk image (or +Edison zip archive) with a built commit from Resin.io. +This can be used with cloud builds, or images deployed with resin deploy. + +Examples: + $ resin preload resin.img --app 1234 --commit e1f2592fc6ee949e68756d4f4a48e49bff8d72a0 --splash-image some-image.png + $ resin preload resin.img + +### Options + +#### --app, -a <appId> + +id of the application to preload + +#### --commit, -c <hash> + +a specific application commit to preload, use "latest" to specify the latest commit +(ignored if no appId is given) + +#### --splash-image, -s <splashImage.png> + +path to a png image to replace the splash screen + +#### --dont-detect-flasher-type-images + +Disables the flasher type images detection: treats all images as non flasher types + +#### --dont-check-device-type + +Disables check for matching device types in image and application + +#### --docker, -P <docker> + +Path to a local docker socket + +#### --dockerHost, -h <dockerHost> + +The address of the host containing the docker daemon + +#### --dockerPort, -p <dockerPort> + +The port on which the host docker daemon is listening + +#### --ca <ca> + +Docker host TLS certificate authority file + +#### --cert <cert> + +Docker host TLS certificate file + +#### --key <key> + +Docker host TLS key file + # Settings ## settings diff --git a/package.json b/package.json index d49db1fc..6e4769e1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "resin-cli", - "version": "6.7.3", + "version": "6.7.4", "description": "The official resin.io CLI tool", "main": "./build/actions/index.js", "homepage": "https://github.com/resin-io/resin-cli",