bonsai-notes-manager 0.1.0
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/LICENSE +21 -0
- package/README.md +67 -0
- package/bonsai +0 -0
- package/package.json +29 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Kirill Szarka
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
|
|
2
|
+
# bonsai
|
|
3
|
+
|
|
4
|
+
Bonsai is a note manager for a vault. It’s for managing notes, while you can bring your own editor for whatever feels most comfortable.
|
|
5
|
+
|
|
6
|
+
## Install
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
npm install -g @unitdhda/bonsai
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Dependencies
|
|
13
|
+
|
|
14
|
+
Core:
|
|
15
|
+
- `jj` or `git` — syncing
|
|
16
|
+
- your `$EDITOR` — opening notes for editing
|
|
17
|
+
|
|
18
|
+
Optional UX tools:
|
|
19
|
+
- `tv` / `fzf` / `find` — fuzzy picking
|
|
20
|
+
- `yazi` — note browsing
|
|
21
|
+
- `dprint` — previews
|
|
22
|
+
- `bat` — handy for Television preview actions
|
|
23
|
+
|
|
24
|
+
## What this is for
|
|
25
|
+
|
|
26
|
+
- browsing, searching, and managing notes
|
|
27
|
+
- daily notes, habits, tasks, backlinks, and quick capture
|
|
28
|
+
- sync workflows that adapt to what you have installed
|
|
29
|
+
|
|
30
|
+
Actions are dependency-agnostic: bonsai prefers the best available tool, then falls back when needed.
|
|
31
|
+
|
|
32
|
+
## Common commands
|
|
33
|
+
|
|
34
|
+
- `bonsai` — open the TUI
|
|
35
|
+
- `bonsai search` — fuzzy pick a note
|
|
36
|
+
- `bonsai search <text>` — search titles, ids, tags
|
|
37
|
+
- `bonsai today` — open today’s daily note
|
|
38
|
+
- `bonsai yesterday` / `bonsai tomorrow`
|
|
39
|
+
- `bonsai recent` — show recent notes
|
|
40
|
+
- `bonsai sync` — sync through `jj` or `git`
|
|
41
|
+
- `bonsai doctor` — check vault health
|
|
42
|
+
|
|
43
|
+
## In the TUI
|
|
44
|
+
|
|
45
|
+
Type a command, then press Enter.
|
|
46
|
+
|
|
47
|
+
Useful ones:
|
|
48
|
+
- `search`
|
|
49
|
+
- `explore`
|
|
50
|
+
- `today`
|
|
51
|
+
- `recent`
|
|
52
|
+
- `sync`
|
|
53
|
+
- `habits`
|
|
54
|
+
- `tasks`
|
|
55
|
+
|
|
56
|
+
## Build
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
bun build ./notes.ts --compile --outfile ./bonsai
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Files
|
|
63
|
+
|
|
64
|
+
- `notes.ts` — app entry
|
|
65
|
+
- `src/` — source code
|
|
66
|
+
- `mascot.ts` — bonsai art
|
|
67
|
+
- `notes.test.ts` — tests
|
package/bonsai
ADDED
|
Binary file
|
package/package.json
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "bonsai-notes-manager",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "A note manager for a vault",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"private": false,
|
|
7
|
+
"bin": {
|
|
8
|
+
"bonsai": "./bonsai"
|
|
9
|
+
},
|
|
10
|
+
"files": [
|
|
11
|
+
"bonsai",
|
|
12
|
+
"README.md",
|
|
13
|
+
"LICENSE"
|
|
14
|
+
],
|
|
15
|
+
"scripts": {
|
|
16
|
+
"lint": "biome lint notes.ts mascot.ts src/**/*.ts notes.test.ts",
|
|
17
|
+
"lint:fix": "biome lint --write notes.ts mascot.ts src/**/*.ts notes.test.ts",
|
|
18
|
+
"build": "bun build ./notes.ts --compile --outfile ./bonsai",
|
|
19
|
+
"prepublishOnly": "bun build ./notes.ts --compile --outfile ./bonsai"
|
|
20
|
+
},
|
|
21
|
+
"dependencies": {
|
|
22
|
+
"ink": "^7.0.3",
|
|
23
|
+
"react": "^19.2.6",
|
|
24
|
+
"react-devtools-core": "^7.0.1"
|
|
25
|
+
},
|
|
26
|
+
"devDependencies": {
|
|
27
|
+
"@biomejs/biome": "^2.4.15"
|
|
28
|
+
}
|
|
29
|
+
}
|