5 guestfish - the libguestfs filesystem interactive shell
9 guestfish [--options] [commands]
11 guestfish -i libvirt-domain
13 guestfish -i disk-image(s)
17 =head2 From shell scripts
19 Create a new C</etc/motd> file in a guest:
24 mount /dev/VolGroup00/LogVol00 /
25 write_file /etc/motd "Hello users" 0
28 List the LVs in a guest:
36 =head2 On the command line
38 List the LVM PVs in a guest image:
40 guestfish add disk.img : run : pvs
42 Remove C</boot/grub/menu.lst> (in reality not such a great idea):
44 guestfish --add disk.img \
45 --mount /dev/VolGroup00/LogVol00 \
46 --mount /dev/sda1:/boot \
47 rm /boot/grub/menu.lst
49 =head2 As an interactive shell
53 Welcome to guestfish, the libguestfs filesystem interactive shell for
54 editing virtual machine filesystems.
56 Type: 'help' for help with commands
57 'quit' to quit the shell
61 =head2 As a script interpreter
63 #!/usr/bin/guestfish -f
64 alloc /tmp/output.img 10M
66 sfdisk /dev/sda 0 0 0 ,
71 eval `guestfish --listen`
72 guestfish --remote cmd
76 Guestfish is a shell and command-line tool for examining and modifying
77 virtual machine filesystems. It uses libguestfs and exposes all of
78 the functionality of the guestfs API, see L<guestfs(3)>.
86 Displays general help on options.
88 =item B<-h> | B<--cmd-help>
90 Lists all available guestfish commands.
92 =item B<-h cmd> | B<--cmd-help cmd>
94 Displays detailed help on a single command C<cmd>.
96 =item B<-a image> | B<--add image>
98 Add a block device or virtual machine image to the shell.
100 =item B<-D> | B<--no-dest-paths>
102 Don't tab-complete paths on the guest filesystem. It is useful to be
103 able to hit the tab key to complete paths on the guest filesystem, but
104 this causes extra "hidden" guestfs calls to be made, so this option is
105 here to allow this feature to be disabled.
107 =item B<-f file> | B<--file file>
109 Read commands from C<file>. To write pure guestfish
112 #!/usr/bin/guestfish -f
114 =item B<-i> | B<--inspector>
116 Run virt-inspector on the named libvirt domain or list of disk
117 images. If virt-inspector is available and if it can identify
118 the domain or disk images, then partitions will be mounted
119 correctly at start-up.
121 Typical usage is either:
125 (for an inactive libvirt domain called I<myguest>), or:
127 guestfish --ro -i myguest
129 (for active domains, readonly), or specify the block device directly:
131 guestfish -i /dev/Guests/MyGuest
133 You cannot use I<-a>, I<-m>, I<--listen>, I<--remote> or I<--selinux>
134 in conjunction with this option, and options other than I<--ro> might
135 not behave correctly.
137 See also: L<virt-inspector(1)>.
141 Fork into the background and listen for remote commands. See section
142 I<REMOTE CONTROL GUESTFISH OVER A SOCKET> below.
144 =item B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>
146 Mount the named partition or logical volume on the given mountpoint.
148 If the mountpoint is omitted, it defaults to C</>.
150 You have to mount something on C</> before most commands will work.
152 If any C<-m> or C<--mount> options are given, the guest is
153 automatically launched.
155 =item B<-n> | B<--no-sync>
157 Disable autosync. This is enabled by default. See the discussion
158 of autosync in the L<guestfs(3)> manpage.
160 =item B<--remote[=pid]>
162 Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section
163 I<REMOTE CONTROL GUESTFISH OVER A SOCKET> below.
165 =item B<-r> | B<--ro>
167 This changes the C<-m> option so that mounts are done read-only
168 (see C<guestfs_mount_ro> in the L<guestfs(3)> manpage).
172 Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>.
174 =item B<-v> | B<--verbose>
176 Enable very verbose messages. This is particularly useful if you find
179 =item B<-V> | B<--version>
181 Display the guestfish / libguestfs version number and exit.
185 Echo each command before executing it.
189 =head1 COMMANDS ON COMMAND LINE
191 Any additional (non-option) arguments are treated as commands to
194 Commands to execute should be separated by a colon (C<:>), where the
195 colon is a separate parameter. Thus:
197 guestfish cmd [args...] : cmd [args...] : cmd [args...] ...
199 If there are no additional arguments, then we enter a shell, either an
200 interactive shell with a prompt (if the input is a terminal) or a
201 non-interactive shell.
203 In either command line mode or non-interactive shell, the first
204 command that gives an error causes the whole shell to exit. In
205 interactive mode (with a prompt) if a command fails, you can continue
208 =head1 USING launch (OR run)
210 As with L<guestfs(3)>, you must first configure your guest by adding
211 disks, then launch it, then mount any disks you need, and finally
212 issue actions/commands. So the general order of the day is:
234 C<run> is a synonym for C<launch>. You must C<launch> (or C<run>)
235 your guest before mounting or performing any other commands.
237 The only exception is that if the C<-m> or C<--mount> option was
238 given, the guest is automatically run for you (simply because
239 guestfish can't mount the disks you asked for without doing this).
243 You can quote ordinary parameters using either single or double
246 add "file with a space.img"
252 A few commands require a list of strings to be passed. For these, use
253 a whitespace-separated list, enclosed in quotes. Strings containing whitespace
254 to be passed through must be enclosed in single quotes. A literal single quote
255 must be escaped with a backslash.
257 vgcreate VG "/dev/sda1 /dev/sdb1"
258 command "/bin/echo 'foo bar'"
259 command "/bin/echo \'foo\'"
261 =head1 WILDCARDS AND GLOBBING
263 Neither guestfish nor the underlying guestfs API performs
264 wildcard expansion (globbing) by default. So for example the
265 following will not do what you expect:
269 Assuming you don't have a directory literally called C</home/*>
270 then the above command will return an error.
272 To perform wildcard expansion, use the C<glob> command.
276 runs C<rm-rf> on each path that matches (ie. potentially running
277 the command many times), equivalent to:
283 C<glob> only works on simple guest paths and not on device names.
285 If you have several parameters, each containing a wildcard, then glob
286 will perform a cartesian product.
290 Any line which starts with a I<#> character is treated as a comment
291 and ignored. The I<#> can optionally be preceeded by whitespace,
292 but B<not> by a command. For example:
298 Blank lines are also ignored.
300 =head1 RUNNING COMMANDS LOCALLY
302 Any line which starts with a I<!> character is treated as a command
303 sent to the local shell (C</bin/sh> or whatever L<system(3)> uses).
307 tgz-out /remote local/remote-data.tar.gz
309 will create a directory C<local> on the host, and then export
310 the contents of C</remote> on the mounted filesystem to
311 C<local/remote-data.tar.gz>. (See C<tgz-out>).
315 Use C<command E<lt>spaceE<gt> | command> to pipe the output of the
316 first command (a guestfish command) to the second command (any host
317 command). For example:
319 cat /etc/passwd | awk -F: '$3 == 0 { print }'
321 (where C<cat> is the guestfish cat command, but C<awk> is the host awk
322 program). The above command would list all accounts in the guest
323 filesystem which have UID 0, ie. root accounts including backdoors.
326 hexdump /bin/ls | head
327 list-devices | tail -1
329 The space before the pipe symbol is required, any space after the pipe
330 symbol is optional. Everything after the pipe symbol is just passed
331 straight to the host shell, so it can contain redirections, globs and
332 anything else that makes sense on the host side.
334 To use a literal argument which begins with a pipe symbol, you have
339 =head1 HOME DIRECTORIES
341 If a parameter starts with the character C<~> then the tilde may be
342 expanded as a home directory path (either C<~> for the current user's
343 home directory, or C<~user> for another user).
345 Note that home directory expansion happens for users known I<on the
346 host>, not in the guest filesystem.
348 To use a literal argument which begins with a tilde, you have to quote
353 =head1 EXIT ON ERROR BEHAVIOUR
355 By default, guestfish will ignore any errors when in interactive mode
356 (ie. taking commands from a human over a tty), and will exit on the
357 first error in non-interactive mode (scripts, commands given on the
360 If you prefix a command with a I<-> character, then that command will
361 not cause guestfish to exit, even if that (one) command returns an
364 =head1 REMOTE CONTROL GUESTFISH OVER A SOCKET
366 Guestfish can be remote-controlled over a socket. This is useful
367 particularly in shell scripts where you want to make several different
368 changes to a filesystem, but you don't want the overhead of starting
369 up a guestfish process each time.
371 Start a guestfish server process using:
373 eval `guestfish --listen`
375 and then send it commands by doing:
377 guestfish --remote cmd [...]
379 To cause the server to exit, send it the exit command:
381 guestfish --remote exit
383 Note that the server will normally exit if there is an error in a
384 command. You can change this in the usual way. See section I<EXIT ON
387 =head2 CONTROLLING MULTIPLE GUESTFISH PROCESSES
389 The C<eval> statement sets the environment variable C<$GUESTFISH_PID>,
390 which is how the C<--remote> option knows where to send the commands.
391 You can have several guestfish listener processes running using:
393 eval `guestfish --listen`
395 eval `guestfish --listen`
398 guestfish --remote=$pid1 cmd
399 guestfish --remote=$pid2 cmd
401 =head2 REMOTE CONTROL DETAILS
403 Remote control happens over a Unix domain socket called
404 C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective
405 user ID of the process, and C<$PID> is the process ID of the server.
407 Guestfish client and server versions must match exactly.
409 =head1 GUESTFISH COMMANDS
411 The commands in this section are guestfish convenience commands, in
412 other words, they are not part of the L<guestfs(3)> API.
414 =head2 alloc | allocate
418 This creates an empty (zeroed) file of the given size, and then adds
419 so it can be further examined.
421 For more advanced image creation, see L<qemu-img(1)> utility.
423 Size can be specified (where C<nn> means a number):
427 =item C<nn> or C<nn>K or C<nn>KB
429 number of kilobytes, eg: C<1440> = standard 3.5in floppy
431 =item C<nn>M or C<nn>MB
435 =item C<nn>G or C<nn>GB
441 number of 512 byte sectors
449 This echos the parameters to the terminal.
451 =head2 edit | vi | emacs
455 This is used to edit a file. It downloads the file, edits it
456 locally using your editor, then uploads the result.
458 The editor is C<$EDITOR>. However if you use the alternate
459 commands C<vi> or C<emacs> you will get those corresponding
462 NOTE: This will not work reliably for large files
463 (> 2 MB) or binary files containing \0 bytes.
469 Expand wildcards in any paths in the args list, and run C<command>
470 repeatedly on each matching path.
472 See section WILDCARDS AND GLOBBING.
479 Without any parameter, this lists all commands. With a C<cmd>
480 parameter, this displays detailed help for a command.
486 Change the local directory, ie. the current directory of guestfish
489 Note that C<!cd> won't do what you might expect.
497 This is used to view a file.
499 The default viewer is C<$PAGER>. However if you use the alternate
500 command C<less> you will get the C<less> command specifically.
502 NOTE: This will not work reliably for large files
503 (> 2 MB) or binary files containing \0 bytes.
507 This exits guestfish. You can also use C<^D> key.
513 Close and reopen the libguestfs handle. It is not necessary to use
514 this normally, because the handle is closed properly when guestfish
515 exits. However this is occasionally useful for testing.
521 Run the command as usual, but print the elapsed time afterwards. This
522 can be useful for benchmarking operations.
528 =head1 ENVIRONMENT VARIABLES
534 The C<edit> command uses C<$EDITOR> as the editor. If not
539 Used with the I<--remote> option to specify the remote guestfish
540 process to control. See section I<REMOTE CONTROL GUESTFISH OVER A
545 If compiled with GNU readline support, then the command history
546 is saved in C<$HOME/.guestfish>
548 =item LIBGUESTFS_APPEND
550 Pass additional options to the guest kernel.
552 =item LIBGUESTFS_DEBUG
554 Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the
555 same effect as using the B<-v> option.
557 =item LIBGUESTFS_MEMSIZE
559 Set the memory allocated to the qemu process, in megabytes. For
562 LIBGUESTFS_MEMSIZE=700
564 =item LIBGUESTFS_PATH
566 Set the path that guestfish uses to search for kernel and initrd.img.
567 See the discussion of paths in L<guestfs(3)>.
569 =item LIBGUESTFS_QEMU
571 Set the default qemu binary that libguestfs uses. If not set, then
572 the qemu which was found at compile time by the configure script is
575 =item LIBGUESTFS_TRACE
577 Set C<LIBGUESTFS_TRACE=1> to enable command traces.
581 The C<more> command uses C<$PAGER> as the pager. If not
582 set, it uses C<more>.
586 Location of temporary directory, defaults to C</tmp>.
588 If libguestfs was compiled to use the supermin appliance then each
589 handle will require rather a large amount of space in this directory
590 for short periods of time (~ 80 MB). You can use C<$TMPDIR> to
591 configure another directory to use in case C</tmp> is not large
598 guestfish returns I<0> if the commands completed without error, or
599 I<1> if there was an error.
604 L<http://libguestfs.org/>,
611 Richard W.M. Jones (C<rjones at redhat dot com>)
615 Copyright (C) 2009 Red Hat Inc.
616 L<http://libguestfs.org/>
618 This program is free software; you can redistribute it and/or modify
619 it under the terms of the GNU General Public License as published by
620 the Free Software Foundation; either version 2 of the License, or
621 (at your option) any later version.
623 This program is distributed in the hope that it will be useful,
624 but WITHOUT ANY WARRANTY; without even the implied warranty of
625 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
626 GNU General Public License for more details.
628 You should have received a copy of the GNU General Public License
629 along with this program; if not, write to the Free Software
630 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.