Skip to main content

LazyArchon Documentation

Complete guide to using LazyArchon - the terminal-based task management TUI for Archon projects

🚀 Getting Started

Installation

LazyArchon can be installed using several methods. Choose the one that works best for your setup:

📜

One-Line Script (Recommended)

Download and install LazyArchon with a single command

curl -sSL https://raw.githubusercontent.com/yousfisaad/lazyarchon/main/scripts/install.sh | bash
🍺

Homebrew (macOS/Linux)

Install via Homebrew package manager

brew install yousfisaad/lazyarchon/lazyarchon
Go

Go Install

Install directly from Go source code

go install github.com/yousfisaad/lazyarchon/cmd/lazyarchon@latest
📦

Binary Downloads

Download pre-built binaries from GitHub Releases

📖 User Guide

Interface Overview

LazyArchon features a clean two-panel layout inspired by terminal file managers like ranger and lf:

Left Panel - Task List

  • • Browse all tasks in the current project
  • • Visual status indicators for each task
  • • Quick navigation with vim-like keys
  • • Filter by features and projects

Right Panel - Task Details

  • • Full task description with markdown
  • • Task metadata (status, assignee, features)
  • • Scrollable content for long descriptions
  • • Rich text formatting and syntax highlighting

Task Status Indicators

Status Symbols

Todo
Task not started yet
Doing
Task in progress
Review
Task under review
Done
Task completed

Visual Indicators

▓░
Scroll Bar
Position indicator with progress
[Tasks]
Active Panel
Bright border indicates focus
[Details]
Inactive Panel
Dimmed when not focused

⌨️ Keyboard Shortcuts

Complete reference for all keyboard shortcuts in LazyArchon. Press ? in-app for help.

Panel Navigation & Movement

h
Switch to left panel (Tasks)
l
Switch to right panel (Details)
j/kor↑/↓
Navigate/scroll in active panel (1 line)
J/K
Fast scroll in active panel (4 lines)
Ctrl+u/d
Half-page scroll in active panel
gg
Jump to first item in active panel
G
Jump to last item in active panel

Task Management

t
Change task status (Todo/Doing/Review/Done)
e
Edit task features (assign/create features)
f
Filter by features (multi-select modal)
s
Change sorting criteria (cycle through modes)

Project Management

p
Enter project selection mode
a
Show all tasks (exit project filter)
Enter
Select project in project mode
Escape
Cancel project selection

Application Controls

r
Refresh data from API
?
Show help modal
q
Quit application
Escape
Close modals/cancel operations

🔧 Troubleshooting

Common Issues

Connection refused / API not available

Error: Failed to load tasks: dial tcp [::1]:8181: connect: connection refused
• Ensure Archon API server is running on localhost:8181
• Check if the server is accessible: curl http://localhost:8181/health
• Verify firewall settings aren't blocking the connection
• Try restarting the Archon API server

Command not found after installation

lazyarchon: command not found
• Check if installation directory is in PATH
• For Go install: Add $(go env GOPATH)/bin to PATH
• For script install: Add ~/.local/bin to PATH
• Restart your terminal after modifying PATH

Terminal display issues

• Ensure terminal supports ANSI colors (most modern terminals do)
• Try running in a different terminal emulator
• Check terminal size: LazyArchon requires minimum 80x24
• Verify UTF-8 support is enabled

Performance issues

• Large task lists may cause slower rendering
• Use project filtering (p key) to reduce displayed items
• Refresh data (r key) if UI becomes unresponsive
• Consider filtering by features to reduce dataset size

Getting Debug Information

Manual API Testing

Test your API connection manually:

$
curl -v http://localhost:8181/health
$
curl -v http://localhost:8181/api/tasks

Getting Help

GitHub Issues

Report bugs and request features

Open Issue

GitHub Discussions

Ask questions and share experiences

Join Discussion