### Preview Documentation with mise Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/developer/guide.md Installs documentation site dependencies and starts the Astro development server for iterative documentation work. ```bash mise run taskwarrior-tui:docs-preview ``` -------------------------------- ### Install Project Tools with mise Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/developer/guide.md After activating mise, install the project's specific tools defined in `.config/mise.toml`. ```bash mise install ``` -------------------------------- ### Install with Snap Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/installation.md Install taskwarrior-tui using the snap package manager. ```bash snap install taskwarrior-tui ``` -------------------------------- ### Install with Homebrew Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/installation.md Use Homebrew to install taskwarrior-tui, which also installs taskwarrior. ```bash brew install taskwarrior-tui ``` -------------------------------- ### Install with Pacman (Arch Linux) Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/installation.md Install taskwarrior-tui from the Arch Linux extra repository using pacman. ```bash pacman -S taskwarrior-tui ``` -------------------------------- ### Install mise Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/developer/guide.md Installs the mise version manager. Activate it in your shell by adding the appropriate command to your shell's configuration file. ```bash curl https://mise.run | sh ``` ```bash # zsh echo 'eval "$(mise activate zsh)"' >> "${ZDOTDIR-$HOME}/.zshrc" # bash echo 'eval "$(mise activate bash)"' >> ~/.bashrc # fish echo 'mise activate fish | source' >> ~/.config/fish/config.fish ``` -------------------------------- ### Install with AUR Helper (Arch Linux) Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/installation.md Install the git version of taskwarrior-tui from the AUR using an AUR helper like yay. ```bash yay -S taskwarrior-tui-git ``` -------------------------------- ### TokyoNight Moon Theme Example Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/colors.md An example configuration of various Taskwarrior color attributes to create a 'TokyoNight Moon' theme. ```plaintext color.active=color111 on color60 color.overdue=color203 color.due.today=color215 color.due=color111 color.blocked=color245 color.tagged=color141 color.recurring=color147 color.scheduled=color109 ``` -------------------------------- ### Example .taskrc Configuration Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/README.md This is an example of a .taskrc file that configures both taskwarrior and taskwarrior-tui. It sets data location, verbosity, user-defined attributes, and color configurations. It also defines custom reports for 'next' tasks, specifying labels and columns to match taskwarrior's CLI output. ```taskrc ### taskwarrior configuration options # taskwarrior's configuration data.location=.task verbose=affected,blank,context,edit,header,footnote,label,new-id,project,special,sync,recur uda.priority.values=H,M,,L color.alternate= # taskwarrior-tui reads color attributes from the following to display the same colors of tasks as the CLI color.tagged=black on rgb444 # Remove age, tags from task next report. # taskwarrior-tui reads the labels and columns from these options to display tasks the same way taskwarrior does report.next.labels=ID,Active,Age,Deps,P,Project,Tag,Recur,S,Due,Until,Description,Urg report.next.columns=id,start.age,entry.age,depends,priority,project,tags,recur,scheduled.countdown,due.relative,until.remaining,description.truncated_count,urgency report.next.filter=(status:pending or status:waiting) page:limit ``` -------------------------------- ### Example Shortcut Script Execution Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/advanced.md Illustrates how a shortcut script is executed with selected task UUIDs as arguments. The script modifies the task to add the 'personal' tag. ```bash ~/.config/taskwarrior-tui/shortcut-scripts/add-personal-tag.sh $selected_tasks_uuid ``` ```plaintext task rc.bulk=0 rc.confirmation=off rc.dependency.confirmation=off rc.recurrence.confirmation=off "$@" modify +personal ``` -------------------------------- ### Configure Background Task Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/advanced.md Set up a background task to run periodically. This example configures 'task sync' to run every 60 seconds. If the process fails, it will not restart automatically. ```plaintext uda.taskwarrior-tui.background_process=task sync uda.taskwarrior-tui.background_process_period=60 ``` -------------------------------- ### Get Application Logs Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/developer/guide.md Launches the taskwarrior-tui application or runs it via Cargo. The `TASKWARRIOR_TUI_LOG_LEVEL=debug` environment variable is automatically set when `mise` is activated. ```bash taskwarrior-tui # OR cargo run ``` -------------------------------- ### Combined Modifiers and Colors Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/colors.md Examples of combining multiple text modifiers with color settings. ```plaintext bold underline red on blue italic color111 on color60 ``` -------------------------------- ### Clean Taskwarrior Test Data Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/developer/guide.md Removes the `tests/data/.task` directory without starting the TUI. ```bash mise run taskwarrior-tui:clean-taskdata ``` -------------------------------- ### Customize Shortcut Key Binding Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/advanced.md Remap default shortcut keys (1-9) to different keys using the taskrc configuration. This example changes the key for shortcut1 to 'n'. ```plaintext uda.taskwarrior-tui.keyconfig.shortcut1=n ``` -------------------------------- ### Override Taskwarrior CLI Path Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/advanced.md Specify a custom path to the Taskwarrior executable using the TASKWARRIOR_TUI_TASKWARRIOR_CLI environment variable. Useful for non-standard installations or wrapped binaries. ```bash TASKWARRIOR_TUI_TASKWARRIOR_CLI=/usr/local/bin/task taskwarrior-tui ``` ```bash export TASKWARRIOR_TUI_TASKWARRIOR_CLI=/usr/local/bin/task ``` -------------------------------- ### Build Documentation with mise Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/developer/guide.md Builds the Starlight documentation site located in the `docs/` directory. ```bash mise run taskwarrior-tui:docs-build ``` -------------------------------- ### Build from Source Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/installation.md Clone the repository and build the release version using Cargo. ```bash git clone https://github.com/kdheepak/taskwarrior-tui.git cd taskwarrior-tui cargo build --release ``` -------------------------------- ### Run a Release Build with Cargo Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/developer/guide.md Executes the application in release mode using Cargo. ```bash cargo run --release ``` -------------------------------- ### Build the CLI with Cargo Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/developer/guide.md Builds the command-line interface using Cargo. Use `--release` for an optimized build. ```bash cargo build ``` ```bash cargo build --release ``` -------------------------------- ### Named Colors and Backgrounds Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/colors.md Demonstrates basic named colors and how to set a background color using the 'on' keyword. ```plaintext red on blue # red foreground, blue background on yellow # default foreground, yellow background ``` -------------------------------- ### Configure taskwarrior-tui Keybindings Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/keys.md Override default taskwarrior-tui keybindings by defining `uda.taskwarrior-tui.keyconfig.*` properties in your `~/.taskrc` file. Each line maps a specific action to a key. ```plaintext uda.taskwarrior-tui.keyconfig.quit=q uda.taskwarrior-tui.keyconfig.refresh=r uda.taskwarrior-tui.keyconfig.go-to-bottom=G uda.taskwarrior-tui.keyconfig.go-to-top=g uda.taskwarrior-tui.keyconfig.down=j uda.taskwarrior-tui.keyconfig.up=k uda.taskwarrior-tui.keyconfig.page-down=J uda.taskwarrior-tui.keyconfig.page-up=K uda.taskwarrior-tui.keyconfig.delete=x uda.taskwarrior-tui.keyconfig.done=d uda.taskwarrior-tui.keyconfig.start-stop=s uda.taskwarrior-tui.keyconfig.quick-tag=t uda.taskwarrior-tui.keyconfig.undo=u uda.taskwarrior-tui.keyconfig.edit=e uda.taskwarrior-tui.keyconfig.duplicate=y uda.taskwarrior-tui.keyconfig.modify=m uda.taskwarrior-tui.keyconfig.shell=! uda.taskwarrior-tui.keyconfig.log=l uda.taskwarrior-tui.keyconfig.add=a uda.taskwarrior-tui.keyconfig.annotate=A uda.taskwarrior-tui.keyconfig.filter=/ uda.taskwarrior-tui.keyconfig.zoom=z uda.taskwarrior-tui.keyconfig.context-menu=c uda.taskwarrior-tui.keyconfig.report-menu=R uda.taskwarrior-tui.keyconfig.next-tab=] uda.taskwarrior-tui.keyconfig.previous-tab=[ ``` -------------------------------- ### Configure with zinit (zsh) Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/installation.md Add taskwarrior-tui to your zsh configuration using zinit for automatic loading. ```zsh zinit ice wait:2 lucid extract"" from"gh-r" as"command" mv"taskwarrior-tui* -> tt" zinit load kdheepak/taskwarrior-tui ``` -------------------------------- ### Run Project Tests with mise Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/developer/guide.md Clones the repository and runs the project's tests using `mise`. This ensures deterministic runs by fetching a pinned commit of `taskwarrior-testdata`. ```bash git clone https://github.com/kdheepak/taskwarrior-tui cd taskwarrior-tui mise run taskwarrior-tui:cargo-test ``` -------------------------------- ### Test Individual Function with Cargo Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/developer/guide.md Sets up test data and runs a specific test function, `test_taskwarrior_timing`, from `src/app.rs` with capture enabled. ```bash mise run taskwarrior-tui:setup-testdata cargo test -- app::tests::test_taskwarrior_timing --nocapture ``` -------------------------------- ### Import Taskwarrior Data Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/developer/guide.md Imports fixture data from `tests/data/export.json` into the taskwarrior-tui's test data directory. ```bash mise run taskwarrior-tui:import-taskdata ``` -------------------------------- ### Run taskwarrior-tui Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/quick_start.md Execute this command in your terminal to launch the taskwarrior-tui application. ```bash taskwarrior-tui ``` -------------------------------- ### Regenerate Man Page with mise Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/developer/guide.md Regenerates the project's man page. ```bash mise run taskwarrior-tui:man ``` -------------------------------- ### Compare taskwarrior-tui with Taskwarrior CLI Commands Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/troubleshooting.md Execute common Taskwarrior commands with timing to compare output and performance against taskwarrior-tui. Use the same environment and configurations. ```bash time task show time task export next time task context time task summary time task ``` -------------------------------- ### Capture Taskwarrior-tui and Task Version Details Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/troubleshooting.md Record the versions of taskwarrior-tui and Taskwarrior CLI, along with diagnostic information, to help identify compatibility issues. ```bash taskwarrior-tui --version task --version task diagnostics ``` -------------------------------- ### Run a Debug Build with Cargo Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/developer/guide.md Executes the application in debug mode using Cargo. ```bash cargo run ``` -------------------------------- ### Configure User-Defined Shortcuts in Taskrc Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/advanced.md Map custom shortcut keys to executable scripts in your Taskwarrior taskrc file. Ensure scripts are executable and have the correct shebang. ```plaintext uda.taskwarrior-tui.shortcuts.1=~/.config/taskwarrior-tui/shortcut-scripts/add-personal-tag.sh uda.taskwarrior-tui.shortcuts.2=~/.config/taskwarrior-tui/shortcut-scripts/sync.sh ... ``` -------------------------------- ### Run TUI with Local Fixture Data Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/developer/guide.md Runs the taskwarrior-tui application using the imported fixture data. The test data directory is removed upon exiting the TUI. ```bash mise run taskwarrior-tui:run-taskdata ``` ```bash mise run taskwarrior-tui:run-taskdata --release ``` -------------------------------- ### Taskwarrior-TUI Command-Line Option Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/advanced.md Use the `-r` option to specify a report to be shown. This overrides the `uda.taskwarrior-tui.task-report.next.filter` setting for that specific instance. ```plaintext -r ``` -------------------------------- ### Taskwarrior-TUI Legacy Config Aliases Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/advanced.md These are older configuration keys that are still accepted for backward compatibility. It is recommended to migrate to the newer names as these may be removed in future releases. The newer key takes precedence if both are set. ```plaintext uda.taskwarrior-tui.task-report.show-info -> uda.taskwarrior-tui.task-report.info-show uda.taskwarrior-tui.tasklist.vertical -> uda.taskwarrior-tui.task-report.info-location ``` -------------------------------- ### 256-Color Indexed Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/colors.md Illustrates using specific indices from the 256-color palette for foreground and background. ```plaintext color196 # bright red color60 on color60 # foreground and background using index 60 ``` -------------------------------- ### Grayscale Ramp Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/colors.md Demonstrates using the grayscale ramp (color indices 232-255) for text and backgrounds. ```plaintext gray5 # dark gray (Color::Indexed(237)) white on gray10 # white text on mid-gray background ``` -------------------------------- ### RGB Color Cube Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/colors.md Shows how to specify colors using the 6x6x6 RGB color cube (terminal colors 16-231) with `rgbRGB` notation. ```plaintext rgb500 # bright red (Color::Indexed(196)) rgb050 # bright green rgb005 # bright blue rgb444 # medium gray-ish ``` -------------------------------- ### High-Intensity Colors Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/colors.md Shows how to use the 'bright' prefix for high-intensity background colors, corresponding to terminal colors 8-15. ```plaintext black on bright green # bright green background white on bright black # bright black (dark gray) background ``` -------------------------------- ### Configure Quick Tag Name Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/advanced.md Configure the tag name used by the quick-tag action. This action toggles a single tag on the selected task. Do not include a leading `+`; taskwarrior-tui adds and removes it automatically. ```plaintext uda.taskwarrior-tui.quick-tag.name=next ``` -------------------------------- ### Bold vs Bright Distinction Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/colors.md Clarifies the difference between the `bold` text attribute and the `bright` color variant, showing how they can be combined. ```plaintext bold red # regular red (#1) + bold attribute on bright red # high-intensity red background (#9) bold on bright red # bold text + high-intensity red background ``` -------------------------------- ### Taskwarrior-TUI Configuration Options Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/advanced.md These options are configured using Taskwarrior user-defined attributes (UDAs) in your `taskrc` file. They control various aspects of the taskwarrior-tui interface, including selection indicators, calendar display, report behavior, and styling. ```plaintext uda.taskwarrior-tui.selection.indicator=• uda.taskwarrior-tui.selection.bold=yes uda.taskwarrior-tui.selection.italic=no uda.taskwarrior-tui.selection.dim=no uda.taskwarrior-tui.selection.blink=no uda.taskwarrior-tui.selection.reverse=no uda.taskwarrior-tui.mark.indicator=✔ uda.taskwarrior-tui.unmark.indicator= uda.taskwarrior-tui.mark-selection.indicator=⦿ uda.taskwarrior-tui.unmark-selection.indicator=⦾ uda.taskwarrior-tui.calendar.months-per-row=4 uda.taskwarrior-tui.task-report.info-show=true uda.taskwarrior-tui.task-report.info-location=auto uda.taskwarrior-tui.task-report.looping=true uda.taskwarrior-tui.task-report.use-alternate-style=true uda.taskwarrior-tui.task-report.jump-to-task-on-add=true uda.taskwarrior-tui.task-report.prompt-on-undo=false uda.taskwarrior-tui.task-report.prompt-on-delete=false uda.taskwarrior-tui.task-report.prompt-on-done=false uda.taskwarrior-tui.style.report.selection= uda.taskwarrior-tui.style.context.active=black on rgb444 uda.taskwarrior-tui.style.report-menu.active=black on rgb444 uda.taskwarrior-tui.style.calendar.title=black on rgb444 uda.taskwarrior-tui.style.report.scrollbar=black uda.taskwarrior-tui.scrollbar.indicator=█ uda.taskwarrior-tui.style.report.scrollbar.area=white uda.taskwarrior-tui.scrollbar.area=║ uda.taskwarrior-tui.task-report.next.filter=$(task show report.next.filter) uda.taskwarrior-tui.task-report.auto-insert-double-quotes-on-add=true uda.taskwarrior-tui.task-report.auto-insert-double-quotes-on-annotate=true uda.taskwarrior-tui.task-report.auto-insert-double-quotes-on-log=true uda.taskwarrior-tui.task-report.reset-filter-on-esc=true uda.taskwarrior-tui.context-menu.select-on-move=false uda.taskwarrior-tui.context-menu.close-on-select=true uda.taskwarrior-tui.report-menu.select-on-move=false uda.taskwarrior-tui.report-menu.close-on-select=true uda.taskwarrior-tui.tabs.change-focus-rotate=false uda.taskwarrior-tui.quick-tag.name=next # UI chrome styles (support all Taskwarrior color formats) uda.taskwarrior-tui.style.title= # default: LightCyan foreground uda.taskwarrior-tui.style.title.border= # default: White foreground uda.taskwarrior-tui.style.help.gauge= # default: Gray foreground uda.taskwarrior-tui.style.command.error= # default: Red foreground ``` -------------------------------- ### Enable Verbose Logging for taskwarrior-tui Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/troubleshooting.md Set the TASKWARRIOR_TUI_LOG_LEVEL environment variable to 'debug' or 'trace' to capture detailed logs for troubleshooting. ```bash TASKWARRIOR_TUI_LOG_LEVEL=debug taskwarrior-tui ``` ```bash TASKWARRIOR_TUI_LOG_LEVEL=trace taskwarrior-tui ``` -------------------------------- ### Capture Crash Backtrace with RUST_BACKTRACE Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/troubleshooting.md Rerun taskwarrior-tui with the RUST_BACKTRACE=1 environment variable set to capture a backtrace when a panic occurs. ```bash RUST_BACKTRACE=1 taskwarrior-tui ``` -------------------------------- ### Capture Taskwarrior-tui Environment Variables Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/troubleshooting.md Log environment variables that might affect taskwarrior-tui's behavior, such as custom paths for Taskrc, Taskdata, or the Taskwarrior CLI. ```bash echo "$TASKRC" echo "$TASKDATA" echo "$TASKWARRIOR_TUI_DATA" echo "$TASKWARRIOR_TUI_TASKWARRIOR_CLI" ``` -------------------------------- ### Alias taskwarrior-tui to tt Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/quick_start.md Add this alias to your shell profile (e.g., ~/.bashrc, ~/.zshrc) for a shorter command to launch taskwarrior-tui. ```bash alias tt="taskwarrior-tui" ``` -------------------------------- ### Taskwarrior-tui Specific Styles Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/colors.md These Taskwarrior attributes allow for `taskwarrior-tui`-specific style customization within the `taskrc` file. ```plaintext uda.taskwarrior-tui.style.context.active uda.taskwarrior-tui.style.calendar.title uda.taskwarrior-tui.style.navbar uda.taskwarrior-tui.style.command uda.taskwarrior-tui.style.report.scrollbar uda.taskwarrior-tui.style.report.scrollbar.area ``` -------------------------------- ### Run Taskwarrior Shell Command Without Prompt Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/faqs.md When running a Taskwarrior command as a shell command within taskwarrior-tui, append `rc.confirmation=off` to prevent the interactive prompt from causing the command to fail. ```bash task rc.confirmation=off context define test project:work ``` -------------------------------- ### Override Taskwarrior TUI Data Directory Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/advanced.md Use the TASKWARRIOR_TUI_DATA environment variable to specify a custom directory for logs and history files. Useful for debugging. ```bash TASKWARRIOR_TUI_DATA=/tmp/taskwarrior-tui-debug taskwarrior-tui ``` -------------------------------- ### Temporarily Disable taskwarrior-tui UI Features Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/troubleshooting.md Modify taskrc settings to disable specific UI components or refresh behaviors to isolate performance issues. Remember to restore settings afterward. ```plaintext uda.taskwarrior-tui.task-report.info-show=0 uda.taskwarrior-tui.task-report.task-detail-prefetch=0 uda.taskwarrior-tui.tick-rate=0 ``` -------------------------------- ### Taskwarrior Color Attributes Source: https://github.com/kdheepak/taskwarrior-tui/blob/main/docs/src/content/docs/configuration/colors.md These are the Taskwarrior color attributes that taskwarrior-tui supports for styling different task states and types. ```plaintext color.deleted color.completed color.active color.alternate color.overdue color.scheduled color.due.today color.due color.blocked color.blocking color.recurring color.tagged ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.