README
Εικόνα)
Ikona (CLI tool for image processing
Install & Run
sudo npm install -g ikona
Then from your command line just type ikona
Now you can use the following commands:
Commands
help [command]
Displays helpful information for a command. e.g. help resize
Example
help resize
exit
Exits from the cli
resize <imageDir>
Resizes an image.
Example
resize realcat.jpg -h 200 -w 200 -o resizecat
Options
Option | Description | |
---|---|---|
-h | The height of the new image | Optional, default="auto" |
-w | The width of the new image | Optional, default="auto" |
-o | The name of the new file | Optional, default="chroma.jpg" |
-m | The algorithm that will be used for resizing | [Bilinear, Nearest_Neighbor, Bicubic, Hermite, Bezier], default=Bilinear |
scale <imageDir>
Scale an image by the given factor
Example
scale realcat.jpg -f 1.5 -o bigcat
Options
Option | Description | |
---|---|---|
-f | Scale factor | Optional, default=2 |
-o | The name of the new file | Optional, default="chroma.jpg" |
-m | The algorithm that will be used | [Bilinear, Nearest_Neighbor, Bicubic, Hermite, Bezier], default=Bilinear |
scaletofit <imageDir>
Scale the image to the largest size that fits inside the given width and height
Example
scaletofit realcat.jpg -h 450 -w 500 -o scaletofitcat
Options
Option | Description | |
---|---|---|
-h | The height of the new image | Optional, default="auto" |
-w | The width of the new image | Optional, default="auto" |
-o | The name of the new file | Optional, default="chroma.jpg" |
-m | The algorithm that will be used | [Bilinear, Nearest_Neighbor, Bicubic, Hermite, Bezier], default=Bilinear |
cover <imageDir>
Scale the image to the given width and height, some parts of the image may be clipped
Example
cover realcat.jpg -h 300 -w 100 -o covercat
Options
Option | Description | |
---|---|---|
-h | The height of the new image | Optional, default="auto" |
-w | The width of the new image | Optional, default="auto" |
-o | The name of the new file | Optional, default="chroma.jpg" |
-m | The algorithm that will be used | [Bilinear, Nearest_Neighbor, Bicubic, Hermite, Bezier], default=Bilinear |
contain <imageDir>
Scale the image to the given width and height, some parts of the image may be letter boxed
Example
contain realcat.jpg -h 200 -w 250 -o containcat
Options
Option | Description | |
---|---|---|
-h | The height of the new image | Optional, default="auto" |
-w | The width of the new image | Optional, default="auto" |
-o | The name of the new file | Optional, default="chroma.jpg" |
swap <imageDir> <channel1> <channel2>
Swap the color channels of an image
Example
swap realcat.jpg green blue
Options
Option | Description | |
---|---|---|
-h | The height of the new image | Optional, default="auto" |
-w | The width of the new image | Optional, default="auto" |
-o | The name of the new file | Optional, default="chroma.jpg" |
-m | The algorithm that will be used for resizing | [Bilinear, Nearest_Neighbor, Bicubic, Hermite, Bezier], default=Bilinear |
crop <imageDir>
Crop an image on the given points
Example
crop realcat.jpeg -x 20 -y 20 -h 70 -w 70 -o croppedcat
Options
Option | Description | |
---|---|---|
-x | Starting point in the x axis | Optional, default=0 |
-y | Starting point in the y axis | Optional, default=0 |
-h | The height of the new image | Optional, default=250 |
-w | The width of the new image | Optional, default=250 |
-o | The name of the new file | Optional, default="chroma.jpg" |
brightness <imageDir>
Adjust the brighness by a value -1 to +1
Example
brightness realcat.jpg -f 0.5 -o brightcat
Options
Option | Description | |
---|---|---|
-f | Brightness factor | Optional, default=1 |
-o | The name of the new file | Optional, default="chroma.jpg" |
contrast <imageDir>
Adjust the contrast by a value -1 to +1
Example
contrast realcat.jpg -f 0.5 -o contrastcat
Options
Option | Description | |
---|---|---|
-f | Contrast factor | Optional, default=1 |
-o | The name of the new file | Optional, default="chroma.jpg" |
grey <imageDir>
Remove colour from the image
Example
grey realcat.jpg -o greycat
Options
Option | Description | |
---|---|---|
-o | The name of the new file | Optional, default="chroma.jpg" |
normalize <imageDir>
Normalize the channels in an image
Example
normalize realcat.jpg -o normalcat
Options
Option | Description | |
---|---|---|
-o | The name of the new file | Optional, default="chroma.jpg" |
invert <imageDir>
Normalize the channels in an image
Example
invert realcat.jpg -o invertcat
Options
Option | Description | |
---|---|---|
-o | The name of the new file | Optional, default="chroma.jpg" |
dominant <imageDir>
Displays the dominant colors of an image
Example
dominant abstract.jpg -h
Options
Option | Description | |
---|---|---|
-h | Displays the colors in hex format | |
-w | Displays the colors in rgba format |
fade <imageDir>
Multiply the alpha channel by each pixel by the factor f, 0 - 1
Example
fade realcat.jpg -f 0.5 -o fadecat
Options
Option | Description | |
---|---|---|
-f | Fade factor | Optional, default=1 |
-o | The name of the new file | Optional, default="chroma.jpg" |
sepia <imageDir>
Apply a sepia wash to the image
Example
sepia realcat.jpg -o sepiacat
Options
Option | Description | |
---|---|---|
-o | The name of the new file | Optional, default="chroma.jpg" |
posterize <imageDir>
Apply a posterization effect with f factor
Example
posterize realcat.jpg -f 5 -o postercat
Options
Option | Description | |
---|---|---|
-f | Posterize factor | Optional, default=1 |
-o | The name of the new file | Optional, default="chroma.jpg" |
rotate <imageDir>
Rotate the image clockwise by a number of degrees.
Example
rotate realcat.jpg -d 30 -o rotatedcat
Options
Option | Description | |
---|---|---|
-d | Degrees | Optional, default=90 |
-o | The name of the new file | Optional, default="chroma.jpg" |
flip <imageDir>
Rotate the image clockwise by a number of degrees.
Example
flip realcat.jpg -h -o flippedcat
Options
Option | Description | |
---|---|---|
-h | Horizontally | |
-v | Vertically | |
-o | The name of the new file | Optional, default="chroma.jpg" |