TJ3CLIENT(1)

📦
version 3.8.1 · 5 versions
, in ubuntu resolute, ubuntu stonking

💅 tj3client — the group-chat-to-the-daemon situation

okay so bestie, you know how tj3d is out there just vibing as the TaskJuggler daemon, holding all your projects? 💖 Well tj3client is literally how you slide into its DMs. It's the client that sends commands and data over to the TaskJuggler daemon, and the whole convo happens over TCP/IP. no cap.

✨ SYNOPSIS ✨

tj3client [options] <command> [arg1 arg2 ...]

🦋 DESCRIPTION 🦋

The TaskJuggler client does exactly one job and it does it iconic: it sends commands and data to the TaskJuggler daemon. Communication goes down via TCP/IP. Periodt.

So here's the roster of commands you can send, bestie 👑

  • status — Shows you the status of the available projects. vibe check on the whole daemon basically.
  • terminate — Terminates the TaskJuggler daemon. 💀 yes it kills it. that's the whole point.
  • add <tjp file> [<tji file> ...] — Add a brand new project, or update one that already exists.
  • update — Reloads all the projects that have modified files and are not already being reloaded. lowkey efficient of it.
  • remove <project ID> [<project ID> ...] — Removes the project (or projects) with the specified ID from the daemon.
  • report <project ID> <report ID> [<report ID> ...] [= [<tji file> ...]] — Generates the report with the provided ID for the project with the given ID.
  • list-reports <project ID> [report ID ] — Lists all the available reports of the project, or just the ones matching the report ID you gave it.
  • check-ts <project ID> <time sheet> — Checks the time sheet you provided for correctness against the project with the given ID. it's giving quality control 🔥
  • check-ss <project ID> <status sheet> — Checks the status sheet you provided for correctness against the project with the given ID.

🎀 OPTIONS 🎀

  • -c, --config <FILE> — Use the YAML configuration file you specified. yes bestie, YAML.
  • --silent — Don't show program and progress information. 🤫 silence, she's working.
  • --no-color — Don't use ANSI control sequences to color the terminal output. Colors should only be used when spooling to an ANSI terminal — and if the detection fails, this is your emergency "turn the colors OFF" button.
  • --debug — Enable Ruby debug mode. 🐛
  • -p, --port <NUMBER> — Use the TCP/IP port you specified.
  • --urifile <FILE> — If the port is 0, use this file to get the URI of the server.
  • -r, --regexp — The report IDs are not fixed — they're regular expressions that match a set of reports. icon behavior.
  • --unsafe — Run the program without sandbox protection.
⚠️ bestie NO. This is not recommended for normal operation! It may only be used for debugging or testing purposes. seriously, don't make this your everyday look. 🙈
  • --format [FORMAT] — Request the report to be generated in the specified format. 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.
  • -h, --help — Show this message. 🫶
  • --version — Show version info.

🌸 ENVIRONMENT 🌸

  • HOME — The user's home folder. Used to search for the configuration file if it wasn't specified. tysm HOME, doing the lord's work.

🧚 FILES 🧚

.taskjugglerrc or taskjuggler.rc

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/. and at minimum that file has to contain this:

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

(the user should specify their own auth key and set file permissions accordingly). 💜 btw you can point at a totally different config file location with the -c, --config FILE option if you're feeling adventurous.

🌈 EXAMPLES 🌈

Load a project:

tj3client add yourproject.tjp

List available reports for a project:

tj3client list-reports <project_id>

Generate a report:

tj3client report <project_id> <report_id>

Terminate a running instance of the server:

tj3client terminate

Copyright © 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020

by Chris Schlaeger <cs@taskjuggler.org>

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.

For more info about TaskJuggler see http://www.taskjuggler.org

⭐ SEE ALSO ⭐

and that's the whole page, bestie 🎀 this was TaskJuggler 3.8.1, dated January 2026 — the tj3client(1) manual. go forth and slay your projects. mwah 💖✨

📦 where this page comes from