tuiboard 0.5.3 → 0.5.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +69 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -39,6 +39,71 @@ bun install
|
|
|
39
39
|
bun run dev # or: bun link → then `tuiboard` globally, live-linked
|
|
40
40
|
```
|
|
41
41
|
|
|
42
|
+
## Quick start
|
|
43
|
+
|
|
44
|
+
Starting fresh — no Obsidian, no special folders required:
|
|
45
|
+
|
|
46
|
+
1. **Install Bun** ([bun.sh](https://bun.sh)), then `bun install -g tuiboard`.
|
|
47
|
+
2. **Make one or more board files.** A board is a plain `.md` file: every `##`
|
|
48
|
+
heading is a column, every `- [ ]` line is a task. The simplest board:
|
|
49
|
+
```markdown
|
|
50
|
+
## To Do
|
|
51
|
+
- [ ] My first task
|
|
52
|
+
|
|
53
|
+
## In Progress
|
|
54
|
+
|
|
55
|
+
## Done
|
|
56
|
+
```
|
|
57
|
+
Create one file per tab you want (e.g. `Work.md`, `Personal.md`). Columns
|
|
58
|
+
named exactly `Done` and `Archive` are treated specially (hidden from the
|
|
59
|
+
board view but used by the done-stats and the archive action).
|
|
60
|
+
3. **Point tuiboard at them.** Create `~/.config/tuiboard/config.yaml` (found
|
|
61
|
+
from any directory) with **absolute** paths:
|
|
62
|
+
```yaml
|
|
63
|
+
boards:
|
|
64
|
+
- path: /home/you/notes/Work.md
|
|
65
|
+
name: Work
|
|
66
|
+
- path: /home/you/notes/Personal.md
|
|
67
|
+
name: Personal
|
|
68
|
+
```
|
|
69
|
+
Or skip the config entirely and just run `tuiboard` inside a folder that
|
|
70
|
+
already contains `.md` files with `- [ ]` tasks — it auto-discovers them.
|
|
71
|
+
4. **Run it:** `tuiboard`.
|
|
72
|
+
|
|
73
|
+
**The Agent view needs zero setup.** tuiboard reads your local Claude Code
|
|
74
|
+
sessions from `~/.claude/` automatically, so the live agent strip fills in as
|
|
75
|
+
soon as you've used Claude Code — nothing to connect or configure. (Tools that
|
|
76
|
+
don't write to `~/.claude`, like Codex, won't show up there.)
|
|
77
|
+
|
|
78
|
+
See [Configure](#configure) for assignees, the done/archive column names, and
|
|
79
|
+
the optional custom "open session in your terminal" command.
|
|
80
|
+
|
|
81
|
+
### Let an AI agent set it up for you
|
|
82
|
+
|
|
83
|
+
Paste this into **Claude Code** (or Codex / Cursor) from any directory — it
|
|
84
|
+
interviews you and wires everything up:
|
|
85
|
+
|
|
86
|
+
```text
|
|
87
|
+
I just installed `tuiboard` (a terminal kanban dashboard:
|
|
88
|
+
https://github.com/NazzarenoGiannelli/tuiboard). Set it up for me from scratch:
|
|
89
|
+
|
|
90
|
+
1. Ask me: (a) which directory should hold my board markdown files,
|
|
91
|
+
(b) how many boards/tabs I want and their names (e.g. Work, Personal),
|
|
92
|
+
(c) any assignee names I use.
|
|
93
|
+
2. Create one markdown file per board in that directory. Each file: a few `##`
|
|
94
|
+
column headings — default `## To Do`, `## In Progress`, `## Done` — and no
|
|
95
|
+
tasks yet. Always include a `## Done` column (tuiboard treats columns named
|
|
96
|
+
`Done` and `Archive` specially and hides them from the board view).
|
|
97
|
+
3. Create a global config at `~/.config/tuiboard/config.yaml` (resolve the real
|
|
98
|
+
home path) with a `boards:` list pointing at those files by ABSOLUTE path,
|
|
99
|
+
plus `assignees: [...]`, `done_column: Done`, `archive_column: Archive`.
|
|
100
|
+
4. Do NOT configure the Agent view — tuiboard reads `~/.claude` automatically.
|
|
101
|
+
5. Show me the final config, then tell me to run `tuiboard`, and how to add a
|
|
102
|
+
board later (create a new `.md` and append it to the `boards:` list).
|
|
103
|
+
|
|
104
|
+
Confirm the directory and file names with me before writing any files.
|
|
105
|
+
```
|
|
106
|
+
|
|
42
107
|
## Configure
|
|
43
108
|
|
|
44
109
|
Copy `.tuiboard/config.example.yaml` to a config location and edit the
|
|
@@ -98,6 +163,10 @@ kanban-plugin: board
|
|
|
98
163
|
## Done
|
|
99
164
|
```
|
|
100
165
|
|
|
166
|
+
The `kanban-plugin: board` frontmatter is **optional** — it's only there so the
|
|
167
|
+
file also renders as a board in Obsidian's Kanban plugin. tuiboard itself needs
|
|
168
|
+
just the `##` column headings and `- [ ]` task lines.
|
|
169
|
+
|
|
101
170
|
### Metadata vocabulary
|
|
102
171
|
|
|
103
172
|
| Symbol | Meaning | Notes |
|
package/package.json
CHANGED