mostr/README.md

67 lines
1.8 KiB
Markdown
Raw Normal View History

2024-07-09 14:56:08 +00:00
# mostr
A nested task chat, powered by nostr!
## Quickstart
First, start a nostr dev-relay like
https://github.com/coracle-social/bucket
```sh
cargo run # Listen to events
nostril --envelope --content "realtime message" --kind 90002 | websocat ws://localhost:4736 # Send a test event
```
2024-07-24 22:02:26 +00:00
## Principles
- active task is tracked automatically
- progress through subdivision rather than guessing
- TBI: show/hide closed/done tasks
Recommendation: Flat hierarchy, using tags for filtering (TBI)
## Reference
2024-07-25 19:40:35 +00:00
### Command Syntax
TASK add syntax: `NAME: TAG1 TAG2 ...`
2024-07-24 22:02:26 +00:00
- `TASK` - create task
- `.` - clear filters and reload
- `.TASK` - filter / activate (by id or name) / create & activate task
- `.NUM` - set view depth - how many subtask levels to show
Dots can be repeated to move to parent tasks
- `:[IND][COL]` - add / remove property column COL to IND or end
2024-07-25 07:50:53 +00:00
- `>[TEXT]` - Complete active task and move to parent, with optional state description
- `<[TEXT]` - Close active task and move to parent, with optional state description
2024-07-25 19:40:35 +00:00
- `#TAG` - filter by tag
2024-07-26 08:07:47 +00:00
- `?TAG` - filter by state (type or description)
- `-TEXT` - add text note (comment / description)
2024-07-25 07:50:53 +00:00
State descriptions can be used for example for Kanban columns.
2024-07-26 08:07:47 +00:00
An active tag or state filter will also create new tasks with those corresponding attributes.
2024-07-24 22:02:26 +00:00
2024-07-25 19:51:12 +00:00
### Available Columns
2024-07-24 22:02:26 +00:00
- `id`
- `parentid`
- `name`
- `state`
2024-07-25 19:51:12 +00:00
- `tags`
2024-07-24 22:02:26 +00:00
- `desc` - accumulated notes of the task
- `path` - name including parent tasks
- `rpath` - name including parent tasks up to active task
- `time` - time tracked
- `ttime` - time tracked including subtasks
- TBI: `progress` - how many subtasks are complete
2024-07-25 19:51:12 +00:00
- TBI: `progressp` - subtask completion in percent
2024-07-24 22:02:26 +00:00
For debugging: `props` - Task Property Events
## Plans
2024-07-24 22:02:26 +00:00
- Expiry (no need to fetch potential years of history)
2024-07-25 19:51:12 +00:00
- Web Interface, Messenger integrations
2024-07-24 13:03:34 +00:00
- TUI - Clear terminal?