Skip to main content

taskdog-ui

Command-line interface and terminal user interface for Taskdog task management system.

Overview

This package provides two user interfaces for Taskdog:

CLI (Command-Line Interface)

  • 30+ commands for task management
  • Rich terminal output with colors and formatting
  • Batch operations support
  • Export capabilities (JSON, CSV, Markdown)

TUI (Terminal User Interface)

  • Full-screen interactive interface powered by Textual
  • Real-time task table with filtering and search
  • Gantt chart visualization
  • Vi-style keyboard navigation
  • Modal dialogs for task creation and editing

Installation

Basic installation (CLI and TUI):

pip install taskdog-ui

With server support (includes taskdog-server):

pip install taskdog-ui[server]

For development:

pip install -e ".[dev]"

Prerequisites

IMPORTANT: The CLI and TUI require a running API server. All commands will fail without it.

1. Install the Server

# Server should be installed via workspace
cd /path/to/taskdog
make install

2. Start the Server

# Start the server (required before any CLI/TUI usage)
taskdog-server --host 127.0.0.1 --port 8000

# Or use systemd for auto-start (recommended)
systemctl --user start taskdog-server
systemctl --user enable taskdog-server

3. Configure API Connection

Edit ~/.config/taskdog/cli.toml:

[api]
enabled = true
host = "127.0.0.1"
port = 8000

Or set environment variables:

export TASKDOG_API_HOST=127.0.0.1
export TASKDOG_API_PORT=8000

4. Verify Connection

# Test that CLI can connect to server
taskdog list

Usage

Note: All commands below require the server to be running (see Prerequisites above).

CLI Examples

# Add a task
taskdog add "Implement feature" --priority 3

# View tasks
taskdog list
taskdog gantt

# Task lifecycle
taskdog start 1
taskdog done 1

# Optimization
taskdog optimize --algorithm balanced

TUI

Launch the interactive interface:

taskdog tui

Keyboard shortcuts:

  • a: Add task
  • s: Start task
  • d: Complete task
  • e: Edit task
  • /: Search
  • q: Quit

Architecture

The UI uses:

  • Click: CLI framework
  • Rich: Terminal formatting and rendering
  • Textual: TUI framework
  • httpx: API client (for client-server mode)
  • taskdog-core: Core business logic and infrastructure

Dependencies

  • taskdog-core: Core business logic
  • click: CLI framework
  • rich: Terminal formatting
  • textual: TUI framework
  • httpx: HTTP client

Testing

pytest tests/

License

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

taskdog_ui-0.24.0.tar.gz (158.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

taskdog_ui-0.24.0-py3-none-any.whl (232.2 kB view details)

Uploaded Python 3

File details

Details for the file taskdog_ui-0.24.0.tar.gz.

File metadata

  • Download URL: taskdog_ui-0.24.0.tar.gz
  • Upload date:
  • Size: 158.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for taskdog_ui-0.24.0.tar.gz
Algorithm Hash digest
SHA256 7f18a4d91c2e11f4883962a6c0259d2f1cc01c60a65305d521f6a0b62750418c
MD5 83990f448db55d654b0984008b9ca87e
BLAKE2b-256 96d6c379d6ca6e70575fb620ac3d2c18ae1049358ad525c024d323c288139c63

See more details on using hashes here.

Provenance

The following attestation bundles were made for taskdog_ui-0.24.0.tar.gz:

Publisher: release.yml on Kohei-Wada/taskdog

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file taskdog_ui-0.24.0-py3-none-any.whl.

File metadata

  • Download URL: taskdog_ui-0.24.0-py3-none-any.whl
  • Upload date:
  • Size: 232.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for taskdog_ui-0.24.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7414a110c301c08d7f6b83f05574483cb9c1b78c82d0106da881cc66cf18c749
MD5 55e562b4ef7466e6dfa5a4666be183d5
BLAKE2b-256 f83c987a877332ffb4f3dec2f24384d91040feb7bf7213230eecb6df5490d302

See more details on using hashes here.

Provenance

The following attestation bundles were made for taskdog_ui-0.24.0-py3-none-any.whl:

Publisher: release.yml on Kohei-Wada/taskdog

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page