Skip to content
kaslkasl

Commands

kasl provides a comprehensive set of commands for work activity tracking, task management, and reporting.

Command Overview

Section titled “Command Overview”

Core Commands

Section titled “Core Commands”
  • init - Initialize application configuration
  • watch - Start activity monitoring
  • task - Manage tasks and work items
  • report - Generate and submit reports
  • sum - View monthly summaries

Data Management

Section titled “Data Management”
  • export - Export data to various formats
  • pauses - View pauses and record ones the monitor missed

Organization

Section titled “Organization”
  • tag - Manage task tags and categorization
  • template - Create and use task templates

System Integration

Section titled “System Integration”
  • autostart - Configure automatic startup
  • update - Update application to latest version
  • completions - Print a shell completion script

Quick Reference

Section titled “Quick Reference”

Daily Workflow

Section titled “Daily Workflow”
Terminal window
# Start monitoring (if not already running)
kasl watch


# Create today's tasks
kasl task add --name "Code review" --completeness 0
kasl task add --name "Team meeting" --completeness 0


# Update task progress
kasl task edit 1


# View today's report
kasl report


# Submit report (if configured)
kasl report --send

Task Management

Section titled “Task Management”
Terminal window
# Create tasks
kasl task add --name "Task name" --comment "Description" --completeness 0


# List tasks
kasl task list
kasl task list --all


# Edit tasks
kasl task edit 1
kasl task edit


# Remove tasks
kasl task remove 1 2 3
kasl task remove --today

Recording Missed Absences

Section titled “Recording Missed Absences”
Terminal window
# Record an hour-long lunch the monitor missed
kasl pauses add --start 13:00 --minutes 60 --reason "lunch"


# Record a short absence that must survive the duration filter
kasl pauses add --start 16:20 --minutes 10 --keep


# Review the day
kasl pauses list

Data Export

Section titled “Data Export”
Terminal window
# Export today's data
kasl export --format csv


# Export all data
kasl export all --format json


# Export to specific file
kasl export --output my_report.csv

Tag Management

Section titled “Tag Management”
Terminal window
# Create tags
kasl tag add "urgent" --color "red"
kasl tag add "backend" --color "blue"


# List tags
kasl tag list


# Assign tags to tasks
kasl task add --name "Fix bug" --tags "urgent,backend"


# Filter by tags
kasl task list --tag "urgent"

Templates

Section titled “Templates”
Terminal window
# Create template
kasl template add --name "daily-standup"


# Use template
kasl task add --from-template
kasl task add --template "daily-standup"

Command Categories

Section titled “Command Categories”

Activity Monitoring

Section titled “Activity Monitoring”

Commands for tracking work sessions and activity:

  • watch - Core monitoring functionality
  • pauses - View pauses and record ones the monitor missed

Task Management

Section titled “Task Management”

Commands for organizing and tracking work items:

  • task - Complete task lifecycle management
  • tag - Task categorization and organization
  • template - Reusable task templates

Reporting & Analytics

Section titled “Reporting & Analytics”

Commands for generating insights and reports:

  • report - Daily work reports
  • sum - Monthly summaries and statistics
  • export - Data export for external analysis

System Management

Section titled “System Management”

Commands for application configuration and maintenance:

  • init - Initial setup and configuration
  • autostart - System integration
  • update - Application updates

Getting Help

Section titled “Getting Help”

Command Help

Section titled “Command Help”

Get help for any command:

Terminal window
kasl --help
kasl <command> --help

Examples

Section titled “Examples”

View command examples:

Terminal window
# Show all available commands
kasl --help


# Show specific command help
kasl task --help
kasl task add --help
kasl report --help

Interactive Mode

Section titled “Interactive Mode”

Some commands support interactive mode:

Terminal window
# Interactive task creation
kasl task


# Interactive template selection
kasl task add --from-template


# Interactive task editing
kasl task edit

Command Options

Section titled “Command Options”

Global Options

Section titled “Global Options”

Most commands support these global options:

  • --help - Show command help
  • --version - Show version information

Common Options

Section titled “Common Options”

Many commands support these common options:

  • --date - Specify date (YYYY-MM-DD or ‘today’)
  • --output - Specify output file
  • --format - Specify output format

Debug Options

Section titled “Debug Options”

Debug options for troubleshooting:

  • --foreground - Run in foreground mode
  • --debug - Enable debug logging

Best Practices

Section titled “Best Practices”

Command Organization

Section titled “Command Organization”
  1. Use templates for frequently created tasks
  2. Use tags for task categorization
  3. Regular exports for data backup
  4. Monitor configuration for optimal detection

Workflow Integration

Section titled “Workflow Integration”
  1. Start monitoring at the beginning of your workday
  2. Create tasks as you plan your work
  3. Update progress throughout the day
  4. Review reports at the end of the day

Data Management

Section titled “Data Management”
  1. Regular backups using export functionality
  2. Clean up old data periodically
  3. Validate data using report commands
  4. Monitor database size and performance