File: using-the-cli.md

package info (click to toggle)
vips 8.17.3-2
  • links: PTS
  • area: main
  • in suites: sid
  • size: 52,228 kB
  • sloc: ansic: 169,684; cpp: 12,156; python: 4,887; sh: 733; perl: 40; makefile: 25; javascript: 6
file content (162 lines) | stat: -rw-r--r-- 4,553 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
Title: Using > At the command-line

Use the `vips` command to execute libvips operations from the command-line.
For example:

```bash
$ vips rot k2.jpg x.jpg d90
```

Will rotate the image `k2.jpg` by 90 degrees anticlockwise and write the
result to the file `x.jpg`. If you don't give any arguments to an operation,
`vips` will give a short description, for example:

```bash
$ vips rot
rotate an image
usage:
   rot in out angle
where:
   in           - Input image, input VipsImage
   out          - Output image, output VipsImage
   angle        - Angle to rotate image, input VipsAngle
                        default: d90
                        allowed: d0, d90, d180, d270
```

There's a straightforward relationship with the C API: compare this to the
API docs for [method@Image.rot].

## Listing all operations

You can list all classes with:

```bash
$ vips -l
...
VipsOperation (operation), operations
  VipsSystem (system), run an external command
  VipsArithmetic (arithmetic), arithmetic operations
    VipsBinary (binary), binary operations
      VipsAdd (add), add two images
      ... etc.
```

Each line shows the canonical name of the class (for example `VipsAdd`), the
class nickname (`add` in this case), and a short description.  Some subclasses
of operation will show more: for example, subclasses of `VipsForeign`
will show some of the extra flags supported by the file load/save operations.

The API docs have a [handy table of all libvips operations](
function-list.html), if you want to find out how to do something, try
searching that.

## Optional arguments

Many operations take optional arguments. You can supply these as command-line
options. For example:

```bash
$ vips gamma
gamma an image
usage:
   gamma in out [--option-name option-value ...]
where:
   in           - Input image, input VipsImage
   out          - Output image, output VipsImage
optional arguments:
   exponent     - Gamma factor, input gdouble
                  default: 0.416667
                  min: 1e-06, max: 1000
operation flags: sequential
```

[method@Image.gamma] applies a gamma factor to an image. By
default, it uses 2.4, the sRGB gamma factor, but you can specify any
gamma with the `exponent` option.

Use it from the command-line like this:

```bash
$ vips gamma k2.jpg x.jpg --exponent 0.42
```

This will read file `k2.jpg`, un-gamma it, and
write the result to file `x.jpg`.

## Array arguments

Some operations take arrays of values as arguments. For example,
[method@Image.affine] needs an array of four numbers for the
2x2 transform matrix. You pass arrays as space-separated lists:

```bash
$ vips affine k2.jpg x.jpg "2 0 0 1"
```

You may need the quotes to stop your shell breaking the argument at
the spaces. [func@Image.bandjoin] needs an array of input images to
join, run it like this:

```bash
$ vips bandjoin "k2.jpg k4.jpg" x.tif
```

## Implicit file format conversion

`vips` will automatically convert between image file
formats for you. Input images are detected by sniffing their first few
bytes; output formats are set from the filename suffix. You can see a
list of all the supported file formats with something like:

```bash
$ vips -l foreign
```

Then get a list of the options a format supports with:

```bash
$ vips jpegsave
```

You can pass options to the implicit load and save operations enclosed
in square brackets after the filename:

```bash
$ vips affine k2.jpg x.jpg[Q=90,strip] "2 0 0 1"
```

Will write `x.jpg` at quality level 90 and will
strip all metadata from the image.

## Chaining operations

Because each operation runs in a separate process, you can't use
libvips's chaining system to join operations together, you have to use
intermediate files. The command-line interface is therefore quite a bit
slower than Python or C.

The best alternative is to use libvips files for intermediates.
Something like:

```bash
$ vips invert input.jpg t1.v
$ vips affine t1.v output.jpg "2 0 0 1"
$ rm t1.v
```

## Other features

Finally, `vips` has a couple of useful extra options.

- Use `--vips-progress` to get `vips` to display a simple progress indicator.

- Use `--vips-leak` and `vips` will leak-test
  on exit, and also display an estimate of peak memory use.

- Set `G_MESSAGES_DEBUG=VIPS` and GLib will display informational
  and debug messages from libvips.

libvips comes with a couple of other useful programs.  `vipsheader` is a
command which can print image header fields. `vipsedit` can change fields
in `.v` format images. `vipsthumbnail` can make image thumbnails quickly.