This repository has been archived by the owner on Mar 5, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 84
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Florian Krämer
committed
Sep 7, 2015
1 parent
7559833
commit ee5b2b1
Showing
1 changed file
with
59 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,62 @@ | ||
The Image Version Shell | ||
======================= | ||
|
||
The shell comes with three pretty much self explaining commands: `generate`, `remove` and `regenerate`. | ||
|
||
Generate | ||
-------- | ||
|
||
**Arguments** | ||
|
||
* **model (required)**: Value of the model property of the images to generate. | ||
* **version (required)**: Image version to generate. | ||
|
||
**Options** | ||
|
||
* **storageTable**: The storage table for image processing you want to use. | ||
* **limit**: Limits the amount of records to be processed in one batch. | ||
* **keep-old-versions**: Use this switch if you do not want to overwrite existing versions. | ||
|
||
Example: | ||
|
||
```sh | ||
bin\cake imageVersion generate Avatar t150 | ||
``` | ||
|
||
Remove | ||
------ | ||
|
||
**Arguments** | ||
|
||
* **model (required)**: Value of the model property of the images to generate. | ||
* **version (required)**: Image version to generate. | ||
|
||
**Options** | ||
|
||
* **storageTable**: The storage table for image processing you want to use. | ||
* **limit**: Limits the amount of records to be processed in one batch. | ||
|
||
Example: | ||
|
||
```sh | ||
bin\cake imageVersion remove Avatar t150 | ||
``` | ||
|
||
Regenerate | ||
---------- | ||
|
||
**Arguments** | ||
|
||
* **model (required)**: Value of the model property of the images to generate. | ||
|
||
**Options** | ||
|
||
* **storageTable**: The storage table for image processing you want to use. | ||
* **limit**: Limits the amount of records to be processed in one batch. | ||
* **keep-old-versions**: Use this switch if you do not want to overwrite existing versions. | ||
|
||
Example: | ||
|
||
```sh | ||
bin\cake imageVersion regenerate Avatar | ||
``` |