cli

module
v0.0.0-...-f5048bd Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 1, 2026 License: MIT

README

taskmd - Markdown Task Tracker CLI

A terminal-based interface for managing markdown task files with automatic file watching and live updates.

Features

  • Scans directories for markdown task files
  • Interactive TUI built with Bubble Tea
  • Live updates when files change
  • Beautiful markdown rendering

Installation

Build from source
make build
Run directly
make run

Usage

./taskmd

Or from anywhere after installing:

make install
taskmd

Project Structure

apps/cli/
├── cmd/
│   └── taskmd/        # Application entrypoint
│       └── main.go
├── internal/          # Core application logic
├── Makefile          # Build automation
├── go.mod            # Go module definition
└── README.md         # This file

Dependencies

Development

# Build
make build

# Run
make run

# Clean
make clean

# Run unit/integration tests
make test

# Run e2e tests (builds binary, tests full CLI)
make e2e

# Run linter
make lint

# Auto-fix linting issues
make lint-fix

# Build for multiple platforms
make build-all
Code Quality

This project enforces code quality standards using golangci-lint:

  • Function length: Max 60 lines per function
  • Cyclomatic complexity: Max 15 per function
  • Cognitive complexity: Max 20 per function
  • Error handling: All errors must be checked
  • Code formatting: Enforced via gofmt and goimports

Run make lint before committing to ensure your code meets these standards.

Installation of golangci-lint:

# macOS
brew install golangci-lint

# Linux/WSL
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin

# Or using Go
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest

Directories

Path Synopsis
cmd
taskmd command
internal
cli
mcp
web

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL