Documentation

Everything you need to know about the Taskulus file structure and CLI.

Directory Structure

Taskulus keeps everything in a dedicated folder in your repository root.

project/
├── .taskulus/               # Hidden configuration and state
│   ├── taskulus.yml         # Project-level configuration
│   └── state.json           # Local cache (gitignored)
├── issues/                  # The database of issues
│   ├── tskl-001.json
│   ├── tskl-002.json
│   └── ...
└── wiki/                    # Planning documents
    ├── roadmap.md.j2        # Jinja2 template
    └── architecture.md      # Static markdown

CLI Reference

The primary interface for interacting with Taskulus.

Core Commands

  • tsk init - Initialize a new project
  • tsk create - Create a new issue
  • tsk list - List and filter issues
  • tsk show [ID] - Display issue details

Workflow

  • tsk update [ID] - Modify status or fields
  • tsk comment [ID] - Add a comment
  • tsk close [ID] - Close an issue
  • tsk wiki - Render wiki templates

Configuration

Customize Taskulus to fit your team's process.

taskulus.yml

The configuration file defines your issue hierarchy (Epic vs Task), workflow states (Todo, In Progress, Done), and other project defaults.

project:
  key: TSKL
  name: Taskulus Project

hierarchy:
  epic:
    color: blue
  task:
    parent: epic
    color: green

workflow:
  todo: { type: initial }
  in_progress: { type: active }
  done: { type: final }