# Workwarrior Project

Workwarrior is a profile-based productivity system that unifies TaskWarrior, TimeWarrior, JRNL, and Hledger under a single CLI and browser UI.

→ [**Why Work Warrior**](https://workwarrior.babb.tel/whyworkwarrior)

***

## Getting Started

| Page                                                                            | Description                              |
| ------------------------------------------------------------------------------- | ---------------------------------------- |
| [Getting Started](https://workwarrior.babb.tel/guides/starting/getting-started) | Install, first profile, basic usage      |
| [Installation](https://workwarrior.babb.tel/guides/starting/install)            | Platform notes, dependency management    |
| [Commands](https://workwarrior.babb.tel/guides/starting/commands)               | Full command surface and shell functions |
| [Usage Examples](https://workwarrior.babb.tel/guides/starting/usage-examples)   | Practical workflows                      |

## Profiles & Core Concepts

| Page                                                                       | Description                                    |
| -------------------------------------------------------------------------- | ---------------------------------------------- |
| [Profiles](https://workwarrior.babb.tel/guides/profiles/profiles)          | Isolation, resources, UDAs, backup, removal    |
| [Architecture](https://workwarrior.babb.tel/guides/architecture)           | Directory structure, env vars, internals       |
| [Services](https://workwarrior.babb.tel/guides/services/services)          | Overview of all service domains                |
| [Weapons](https://workwarrior.babb.tel/guides/weapons/weapons)             | Gun, Sword, Next, Schedule                     |
| [Heuristics](https://workwarrior.babb.tel/guides/heuristics/heuristics)    | Natural language, 627+ rules, self-improvement |
| [Browser Integration](https://workwarrior.babb.tel/guides/browser/browser) | Web interface, CMD input, panels, API          |

## GitHub Sync

| Page                                                                                                  | Description                |
| ----------------------------------------------------------------------------------------------------- | -------------------------- |
| [GitHub Sync Guide](https://workwarrior.babb.tel/guides/github/github-sync-guide)                     | Two-way sync walkthrough   |
| [GitHub Sync Configuration](https://workwarrior.babb.tel/guides/github/github-sync-configuration)     | Setup and config reference |
| [GitHub Sync Troubleshooting](https://workwarrior.babb.tel/guides/github/github-sync-troubleshooting) | Common issues and fixes    |
| [Testing Guide](https://workwarrior.babb.tel/guides/github/testing-guide)                             | Testing procedures         |

## Search Guides

| Tool     | Guide                                                                          |
| -------- | ------------------------------------------------------------------------------ |
| Tasks    | [guides/search/task.md](https://workwarrior.babb.tel/guides/search/task)       |
| Time     | [guides/search/time.md](https://workwarrior.babb.tel/guides/search/time)       |
| Journals | [guides/search/journal.md](https://workwarrior.babb.tel/guides/search/journal) |
| Ledgers  | [guides/search/ledger.md](https://workwarrior.babb.tel/guides/search/ledger)   |
| Lists    | [guides/search/list.md](https://workwarrior.babb.tel/guides/search/list)       |

## Development & Releases

| Page                                                                                          | Description                 |
| --------------------------------------------------------------------------------------------- | --------------------------- |
| [Service Development](https://workwarrior.babb.tel/guides/services/service-development)       | Build and register services |
| [Release Checklist](https://workwarrior.babb.tel/guides/releases/release-checklist)           | Production readiness gates  |
| [Issues & Troubleshooting](https://workwarrior.babb.tel/guides/issues/issues-troubleshooting) | Bugwarrior debugging        |

## Technical Reference

Per-component documentation for every library, service, and subsystem.

| Section                                                                                                                          | Description                                                        |
| -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| [Binaries](https://workwarrior.babb.tel/reference/bin/ww)                                                                        | Main CLI dispatcher (`ww`) and bootstrap (`ww-init.sh`)            |
| [Core Libraries](https://github.com/babbworks/ww-standard/blob/main/reference/lib/README.md)                                     | Core utilities and managers (profile-manager, sync, logging, etc.) |
| [Services](https://github.com/babbworks/ww-standard/blob/main/reference/services/README.md)                                      | All service-level documentation                                    |
| [Cross-Cutting](https://github.com/babbworks/ww-standard/blob/main/reference/cross-cutting/README.md)                            | Sync engine, config loader, error handling, installer              |
| [Extensions](https://github.com/babbworks/ww-standard/blob/main/reference/extensions/README.md)                                  | TaskWarrior & TimeWarrior extensions                               |
| [Taskwarrior Extensions Overview](https://workwarrior.babb.tel/reference/extensions/taskwarrior/index)                           | Integrations and overviews                                         |
| [Community Extensions List](https://github.com/babbworks/ww-standard/blob/main/reference/extensions/taskwarrior/repos/README.md) | Large list of third-party extensions                               |
| [Source Map](https://github.com/babbworks/ww-standard/blob/main/reference/source-map.yaml)                                       | Maps each doc to its source files                                  |

***

**Tip**: Use the **sidebar** on the left for the complete navigation. Start with [**Why Work Warrior**](https://workwarrior.babb.tel/whyworkwarrior) for the vision.