.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
.TH TJ3CLIENT "1" "June 2020" "TaskJuggler 3.7.1" "TaskJuggler"
.SH NAME
tj3client \- send commands and data to the TaskJuggler daemon
.SH SYNOPSIS
.B tj3client
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,arg1 arg2 \/\fR...]
.SH DESCRIPTION
The TaskJuggler client is used to send commands and data to the TaskJuggler
daemon. The communication is done via TCP/IP.
.PP
The following commands are supported:
.IP
status
.IP
Display the status of the available projects
.IP
terminate
.IP
Terminate the TaskJuggler daemon
.IP
add <tjp file> [<tji file> ...]
.IP
Add a new project or update and existing one
.IP
update
.IP
Reload all projects that have modified files and are not being
reloaded already
.IP
remove <project ID> [<project ID> ...]
.IP
Remove the project with the specified ID from the daemon
.TP
report <project ID> <report ID> [<report ID> ...] [=
[<tji file> ...]]
.IP
Generate the report with the provided ID for the project with the
given ID
.IP
list\-reports <project ID> [report ID ]
.IP
List all available reports of the project or those that match the
provided report ID
.IP
check\-ts <project ID> <time sheet>
.IP
Check the provided time sheet for correctness against the project
with the given ID
.IP
check\-ss <project ID> <status sheet>
.IP
Check the provided status sheet for correctness against the project
with the given ID
.SH OPTIONS
.TP
\fB\-c\fR, \fB\-\-config\fR <FILE>
Use the specified YAML configuration file
.TP
\fB\-\-silent\fR
Don't show program and progress information
.TP
\fB\-\-no\-color\fR
Don't use ANSI contol sequences to color the
terminal output. Colors should only be used when
spooling to an ANSI terminal. In case the detection
fails, you can use this option to force colors to
be off.
.TP
\fB\-\-debug\fR
Enable Ruby debug mode
.TP
\fB\-p\fR, \fB\-\-port\fR <NUMBER>
Use the specified TCP/IP port
.TP
\fB\-\-urifile\fR <FILE>
If the port is 0, use this file to get the URI of
the server.
.TP
\fB\-r\fR, \fB\-\-regexp\fR
The report IDs are not fixed but regular
expressions that match a set of reports
.TP
\fB\-\-unsafe\fR
Run the program without sandbox protection. This is
not recommended for normal operation! It may only
be used for debugging or testing purposes.
.TP
\fB\-\-format\fR [FORMAT]
Request the report to be generated in the
specifiedformat. Use multiple options to request
multiple formats. Supported formats are csv, html,
niku and tjp. By default, the formats specified in
the report definition are used.
.TP
\fB\-h\fR, \fB\-\-help\fR
Show this message
.TP
\fB\-\-version\fR
Show version info
.SH ENVIRONMENT

.TP
\fBHOME\fR
The user's home folder. Used to search for configuration file if not specified.
.SH FILES

.TP
\fB.taskjugglerrc\fR or \fBtaskjuggler.rc\fR
tj3d searches for a config file named .taskjugglerrc or taskjuggler.rc in the current path, the user's home path as specified by the HOME environment variable or /etc/. At a minimum the file must contain:

_global:
  authKey: ********

(the user should specify their own auth key and set file permissions accordingly). An alternative config file location may be specified using the -c, --config FILE option.
.SH EXAMPLES
.TP
Load a project:
tj3client add yourproject.tjp
.PP
.TP
List available reports for a project:
tj3client list-reports <project_id>
.PP
.TP
Generate a report:
tj3client report <project_id> <report_id>
.PP
.TP
Terminate a running instance of the server:
tj3client terminate
.SH COPYRIGHT
Copyright \(co 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020
.IP
by Chris Schlaeger <cs@taskjuggler.org>
.PP
This program is free software; you can redistribute it and/or modify it under
the terms of version 2 of the GNU General Public License as published by the
Free Software Foundation.
.PP
For more info about TaskJuggler see http://www.taskjuggler.org
.SH "SEE ALSO"
tj3d(1)

The full TaskJuggler manual is available online at http://www.taskjuggler.org/tj3/manual/, or via the tj3man command.