Supported platforms: GNU/Linux, MacOS, BSD
Like a rubber ducky that talks back, TicketDuck is a lightweight tool that helps you make your messy stream-of-consciousness more coherent (your friends and colleagues will thank you).
Will it literally debug your life? Absolutely not. How about make you a better leader and team member? Maybe, but that's a lot to ask of a tiny program. Will it make documenting your troubleshooting and development thought process easier? Hopefully yes!
There's no one right way to use this tool, but here's a suggestion:
- Incident Reports: What happened? What did you do? Why did you do it? Did it work? What did you learn?
- Commit Messages: What did you do? Why did you do it? What did you learn?
- Service Requests: What do you want? Why do you want it? What will you do with it?
- Development Ticket: Is this a feature, bug or chore? What is the current behavior? How do you want to change, modify, or add behavior? Why do you want this change? What are the benefits? What are the acceptance criteria for this change?
- To launch the application, navigate to the installation directory and run
go mod tidy
(To download the package dependencies)go build
(To build the binary)./ticketduck
(To execute the binary)- The binary can then be added to your PATH as needed.
- After launching the application, configure the model that you'd like to use.
- Once that's done, select your form type from the main menu.
- Answer each question in the form, or skip the ones that you don't like.
- Submit the form, copy the output, and edit it down to what makes sense.
- Did you save time? Maybe not, but the words were put to the page, and the task of documenting your work has been split into smaller chunks!
Ctrl+q
: Quit the applicationEsc
: Return to main menu (from any mode except selection mode)~
: Switch to model selection modeCtrl+t
: Switch to style selection mode
↑/↓
orj/k
: Navigate through form typesEnter
orSpace
: Select a form type
Enter
: Submit answer and move to next questionCtrl+s
: Skip current questionBackspace
: Delete last characterEsc
: Return to main menu
↑/↓
orj/k
: Scroll up/down one linePgUp/PgDown
: Scroll up/down one pageg
: Press twice to jump to topG
: Jump to bottomCtrl+y
: Copy plain text to clipboardEsc
: Return to main menu
↑/↓
orj/k
: Navigate through model optionsEnter
orSpace
: Select a modelc
: Configure the selected modelEsc
: Return to main menu
↑/↓
orj/k
: Navigate through style themesEnter
: Apply selected themeEsc
: Return to main menu
↑/↓
: Cycle through input fieldsSpace
: Toggle save configuration checkboxEnter
: Save configuration and return to menuEsc
: Return to main menu
Built using Charmbracelet's tools:
- https://github.com/charmbracelet/bubbletea (TUI framework)
- https://github.com/charmbracelet/bubbles (TUI components)
- https://github.com/charmbracelet/glamour (Markdown rendering)
- https://github.com/charmbracelet/lipgloss (CSS-like styling)
Other non-standard dependencies:
- https://github.com/liushuangls/go-anthropic (Community Claude API wrapper for Go)
- https://github.com/openai/openai-go (OpenAI API for Go)
- https://github.com/acarl005/stripansi (Helps format TUI output)
- https://github.com/atotto/clipboard (Takes that output and pipes it to the clipboard)
For submitting issues, we ask that you try using the tool to do so, and if you run into any unexpected behavior, we ask that you attach the client logs, which should be located in ~/.ticketduck/logs/
.