tkhq / tkhq/tk

Improve error messaging & CLI UX

Open
#4 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1
Forks
0
Avg merge
1d 12h
Merged PRs (30d)
15

Description

Rationale

Clear, actionable error messages and intuitive CLI interfaces are critical for developer experience. Current error handling may be opaque, making debugging and troubleshooting time-consuming for users.

Suggested Scope

  • Audit error messages across SDK and CLI for clarity and actionability
  • Implement structured error types with context and suggestions
  • Enhance CLI help text, usage examples, and error recovery hints
  • Add verbosity levels (quiet/normal/verbose/debug) for graduated output
  • Implement color and formatting for readability
  • Add error code documentation and troubleshooting guide
  • Create developer-friendly error handling patterns

Effort Estimate

Medium (2-3 weeks) depending on scope of CLI surface area.

Success Criteria

  • All user-facing errors are descriptive with actionable next steps
  • CLI help and examples are clear and discoverable
  • Error codes documented with troubleshooting guide
  • Verbosity levels working across CLI commands
  • User testing validates improved UX

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue covers error handling across the SDK and CLI but names no files, tests, or specific command entry points. Start by mapping the CLI surface and current user-facing errors, then define a manageable scope before changing anything. Done means the selected errors, help text, verbosity behavior, and documentation meet the stated success criteria.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli, developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.