taskd(1)

📦
version 1.1.0 · 2 versions
, in fedora 43, fedora 44, nixos 26.05, nixpkgs unstable

💅 taskd(1) — the Taskserver glow-up guide

okay bestie, this is the manual for taskd, aka Taskserver — and yes, it's the taskd(1) page, section 1, User Manuals. grab a strawberry drink 🍓 and let's go.

✨ SYNOPSIS ✨

taskd <command> [options] [<args>]
taskd -v|--version
taskd -h|--help
taskd diagnostics
taskd validate <JSON | file>
taskd help [<command>]

🦋 DESCRIPTION 🦋

Taskserver is a sync server for Taskwarrior and related products. that's the whole vibe. it syncs. it serves. it's the main character of your task infrastructure. 👑

🎀 COMMANDS 🎀

Taskserver supports several commands, which provide administrative capabilities. the commands are:

  • taskd init [--data <root>] [options] — Performs a one-time initialization of the Taskserver instance. Creates the bare data structure. Either --data <root> must be specified, or TASKDDATA must be set. it's giving "first day of school" energy — one time only, no redo. 🙈
  • taskd help <command> [options] — Provides option and syntax help for each command. your personal hype friend that tells you how everything works. 💖
  • taskd config [options] [--data <root>] [--force] [<name> [<value>]] — Allows modification of the taskd configuration. Can add, remove, modify or list all configuration settings. Either --data <root> must be specified, or TASKDDATA must be set. it does it all, no cap. ✨
  • taskd server [--daemon] [options] — Starts the server in daemon or TTY mode. While there is no interactivity, the difference is whether taskd is attached to a TTY or not.
💀 heads up: sending the HUP signal to the taskd server causes a configuration file reload before the next request is handled. lowkey iconic behavior, honestly.
  • taskd add [--data <root>] org <org>
  • taskd add [--data <root>] group <org> <group>
  • taskd add [--data <root>] user <org> <user>

Adds organizations, groups and users. Either --data <root> must be specified, or TASKDDATA must be set. new people, new groups, new orgs — the friend group is expanding 🫶

  • taskd remove [--data <root>] org <org>
  • taskd remove [--data <root>] group <org> <group>
  • taskd remove [--data <root>] user <org> <user>

Removes organizations, groups and users. Either --data <root> must be specified, or TASKDDATA must be set. blocking them, basically. 😭

  • taskd suspend [--data <root>] org <org>
  • taskd suspend [--data <root>] group <org> <group>
  • taskd suspend [--data <root>] user <org> <user>

Suspends organizations, groups and users. Either --data <root> must be specified, or TASKDDATA must be set. not cancelled, just on pause — soft launch energy. 🌸

  • taskd resume [--data <root>] org <org>
  • taskd resume [--data <root>] group <org> <group>
  • taskd resume [--data <root>] user <org> <user>

Resumes organizations, groups and users. Either --data <root> must be specified, or TASKDDATA must be set. they're back, and they ate. 💅

  • taskd diagnostics — Displays diagnostic information important when reporting bugs. your receipts, bestie. 🧾
  • taskd validate <JSON | file> — Parses the quoted JSON string or JSON file. Useful for debugging JSON that is generated by Taskserver clients. vibe check for your JSON 🔍
  • taskd client [options] <host:port> <file> [<file> ...] — Sends the Taskserver request in <file> to <host:port>. Options specified must include ca.cert (for self-signed certs), client.cert, client.key. no certs, no entry — it's giving bouncer at the club. 🔥

🌈 COMMON OPTIONS 🌈

Most commands support the following options — these are the little settings that show up everywhere, like that one friend who's at every party:

  • --NAME=VALUE — Temporary configuration override. ✨
  • --force — Does not ask for confirmation of changes. no "are you sure?", just send it. 💀
  • --quiet — Suppresses verbose output. shhh, we're being mysterious 🤫
  • --debug — Shows debugging information. the receipts, the lore, the behind-the-scenes 🎬
  • --data <root> — Many commands require the location of the data root, so either it must be provided as shown, or via the TASKDDATA environment variable. 🗂️

💜 CONFIGURATION 💜

The Taskserver configuration file can be found in the top level of the data root. It is recommended that the taskd config command is used to manipulate this file. like, please don't hand-edit it, bestie, use the tool 🙏

Note that any configuration variable may be overridden on the command line using this syntax:

$ taskd server --NAME=VALUE

In all commands but one, this will _temporarily_ override the value, but with the init command, which creates a config file, overrides are made permanent.

⭐ okay so this is the important part: temporarily for almost everything... but init makes it permanent. one command has main character energy and it's init. 👑

🧚 ENVIRONMENT VARIABLES 🧚

Environment variables provide values that would otherwise be required at the command line. built-in answers, iykyk.

  • TASKDDATA=<root> — Most command require either --data <root> or this environment variable. If both are provided, the command line overrides the environment. so the command line is the boss here, fr fr. 💅

👑 CREDITS & COPYRIGHTS 👑

Copyright (C) 2010 - 2015, Göteborg Bit Factory.

Taskserver is distributed under the MIT license. See http://www.opensource.org/licenses/mit-license.php for more information.

🌸 SEE ALSO 🌸

taskdrc(5),taskdctl(1)

For more information regarding Taskserver, see the following:

🔥 REPORTING BUGS 🔥

Bugs in Taskserver may be reported to the issue-tracker at http://taskwarrior.org

🫶 and that's the whole page, bestie. go forth and sync slayfully. ✨

taskd 1.1.0 🎀 2015-05-10 🎀 and that's the taskd(1) footer, mwah 💋

📦 where this page comes from