.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "TARANTOOLCTL 1"
.TH TARANTOOLCTL 1 2025-11-07 --name=tarantoolctl "Tarantool\ instances\ control"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
tarantoolctl \- a utility to control Tarantool instances
.SH SYNOPSIS
.IX Header "SYNOPSIS"
tarantoolctl COMMAND [INSTANCE] [FILE] [URI] [OPTIONS...]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
tarantoolctl may be used to introspect and control the state
of Tarantool instances.
.PP
The \f(CW\*(C`INSTANCE\*(C'\fR represents the name of an instance file.
.SH COMMANDS
.IX Header "COMMANDS"
The following commands are understood:
.IP "start INSTANCE" 4
.IX Item "start INSTANCE"
Start the Tarantool instance specified on the command line if the
instance is not running. This does nothing if an instance is running.
.IP "stop INSTANCE" 4
.IX Item "stop INSTANCE"
Stop the Tarantool instance specified on the command line if the instance
is running. This does nothing if an instance is not running.
.IP "status INSTANCE" 4
.IX Item "status INSTANCE"
Show status of the Tarantool instance specified on the command line
(started/stopped). If pid file exists and an alive control socket exists,
the return code is \f(CW0\fR. Otherwise, the return code is not \f(CW0\fR.
Reports typical problems to stderr (e.g. pid file exists and control
socket does not).
.IP "restart INSTANCE" 4
.IX Item "restart INSTANCE"
Stop and start the Tarantool instance specified on the command line if
the instance is running. This does nothing if an instance is not running.
.IP "logrotate INSTANCE" 4
.IX Item "logrotate INSTANCE"
Rotate logs of the Tarantool instance specified on the command line if
the instance is running. This works only if logging\-into\-file is enabled in
the instance file (\f(CW\*(C`box.cfg{log=...}\*(C'\fR parameter). Pipe/syslog make no effect.
.IP "check INSTANCE" 4
.IX Item "check INSTANCE"
Check if there are syntax errors in the instance script of the Tarantool
instance specified on the command line.
.IP "enter INSTANCE" 4
.IX Item "enter INSTANCE"
Enter the interactive console of the Tarantool instance specified on
the command line.
.IP "eval INSTANCE FILE" 4
.IX Item "eval INSTANCE FILE"
.PD 0
.IP "COMMAND | tarantoolctl eval INSTANCE" 4
.IX Item "COMMAND | tarantoolctl eval INSTANCE"
.PD
Evaluate a local file on the Tarantool instance specified on the command
line if the instance is running. This does nothing if an instance is not
running.
.IP "connect URI" 4
.IX Item "connect URI"
.PD 0
.IP "COMMAND | tarantoolctl connect URI" 4
.IX Item "COMMAND | tarantoolctl connect URI"
.PD
Connect on an admin\-console port to the Tarantool instance with the URI
specified on the command line. This supports both TCP/Unix sockets.
.IP "cat FILE... [\-\-space=space_no...] [\-\-show\-system] [\-\-from=from_lsn] [\-\-to=to_lsn] [\-\-replica=replica_id]" 4
.IX Item "cat FILE... [--space=space_no...] [--show-system] [--from=from_lsn] [--to=to_lsn] [--replica=replica_id]"
Print into stdout the contents of .snap/.xlog files specified on the
command line.
.IP "play URI FILE... [\-\-space=space_no...] [\-\-show\-system] [\-\-from=from_lsn] [\-\-to=to_lsn] [\-\-replica=replica_id]" 4
.IX Item "play URI FILE... [--space=space_no...] [--show-system] [--from=from_lsn] [--to=to_lsn] [--replica=replica_id]"
Play the contents of .snap/.xlog files to another Tarantool instance with
URI specified on the command line.
.SH OPTIONS
.IX Header "OPTIONS"
The following options are understood:
.IP \-\-space=space_no 4
.IX Item "--space=space_no"
Filter the output by space number. May be passed more than once.
.IP \-\-show\-system 4
.IX Item "--show-system"
Show/play the contents of system spaces.
.IP \-\-from=from_lsn 4
.IX Item "--from=from_lsn"
Show/play operations starting from the given lsn.
.IP \-\-to=to_lsn 4
.IX Item "--to=to_lsn"
Show/play operations ending with the given lsn.
.IP \-\-replica=replica_id 4
.IX Item "--replica=replica_id"
Filter the output by replica ID. May be passed more than once.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
The file with system\-wide defaults for tarantoolctl is installed in
\&\f(CW\*(C`/etc/default/tarantool\*(C'\fR. This file is used when tarantoolctl is invoked
by root. When invoked by a local user, tarantoolctl first looks for its
defaults file in the current directory (\f(CW\*(C`$PWD/.tarantoolctl\*(C'\fR), and then in
the current user\*(Aqs home directory (\f(CW\*(C`$HOME/.config/tarantool/tarantool\*(C'\fR).
If not found, tarantoolctl falls back to built\-in defaults:
.PP
.Vb 9
\&    default_cfg = {
\&    pid_file  = "/var/run/tarantool",
\&    wal_dir   = "/var/lib/tarantool",
\&    memtx_dir = "/var/lib/tarantool",
\&    vinyl_dir = "/var/lib/tarantool",
\&    log       = "/var/log/tarantool",
\&    username  = "tarantool",
\&    }
\&    instance_dir = "/etc/tarantool/instances.enabled"
.Ve
.PP
Most of these parameters are similar to those in \f(CW\*(C`box.cfg{}\*(C'\fR:
.IP pid_file 4
.IX Item "pid_file"
Directory for the pid file and control\-socket file; tarantoolctl will add
"/instance_name" to the directory name.
.IP wal_dir 4
.IX Item "wal_dir"
Directory for write\-ahead *.xlog files; tarantoolctl will add
"/instance_name" to the directory name.
.IP memtx_dir 4
.IX Item "memtx_dir"
Directory for snapshot *.snap files; tarantoolctl will add
"/instance_name" to the directory name.
.IP vinyl_dir 4
.IX Item "vinyl_dir"
Directory for vinyl files; tarantoolctl will add "/instance_name" to the
directory name.
.IP log 4
.IX Item "log"
The place where the application log will go; tarantoolctl will add
"/instance_name.log" to the name.
.IP username 4
.IX Item "username"
The user that runs the Tarantool instance. This is the operating\-system
user name rather than the Tarantool\-client user name. Tarantool will
change its effective user to this user after becoming a daemon.
.IP instance_dir 4
.IX Item "instance_dir"
The directory where all instance files for this host are stored. Put
instance files in this directory, or create symbolic links.
.Sp
As a full\-featured example, you can take \f(CW\*(C`example.lua\*(C'\fR script that ships
with Tarantool and defines all configuration options.
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
On success, \f(CW0\fR is returned, a non\-zero failure code otherwise.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBtarantool\fR\|(1), Tarantool manual at http://tarantool.org/doc/
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2010\-2017 Tarantool AUTHORS: please see AUTHORS file.