vertex-notes 0.1.0 → 0.1.1
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 +130 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
# ▲ Vertex CLI
|
|
2
|
+
|
|
3
|
+
**Your knowledge, structured — from the terminal.**
|
|
4
|
+
|
|
5
|
+
Vertex is a keyboard-first knowledge workspace. This CLI gives you full access to your notes, todos, tags, and search from the command line.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install -g vertex-notes
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Quick Start
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
vertex login # Log in with GitHub, Google, or Email
|
|
17
|
+
vertex notes # List all your notes
|
|
18
|
+
vertex today # Open daily note in interactive mode
|
|
19
|
+
vertex capture "idea" # Quick capture to Inbox
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Commands
|
|
23
|
+
|
|
24
|
+
### Auth
|
|
25
|
+
| Command | Description |
|
|
26
|
+
|---------|-------------|
|
|
27
|
+
| `vertex login` | Log in (GitHub, Google, or Email) |
|
|
28
|
+
| `vertex logout` | Log out and clear session |
|
|
29
|
+
| `vertex whoami` | Show logged-in user |
|
|
30
|
+
|
|
31
|
+
### Notes
|
|
32
|
+
| Command | Description |
|
|
33
|
+
|---------|-------------|
|
|
34
|
+
| `vertex notes` | List all notes |
|
|
35
|
+
| `vertex new [title]` | Create a new note |
|
|
36
|
+
| `vertex view <title>` | View note as markdown |
|
|
37
|
+
| `vertex edit <title>` | Edit in $EDITOR (vim/nano/code) |
|
|
38
|
+
| `vertex daily` | View or create today's daily note |
|
|
39
|
+
| `vertex daily --last` | View the most recent daily note |
|
|
40
|
+
|
|
41
|
+
### Interactive Mode
|
|
42
|
+
|
|
43
|
+
Open any note in a terminal UI with todo toggling:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
vertex today # Latest daily note
|
|
47
|
+
vertex interactive <title> # Any note
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
**Controls:**
|
|
51
|
+
|
|
52
|
+
| Key | Action |
|
|
53
|
+
|-----|--------|
|
|
54
|
+
| `↑ ↓` | Move between items |
|
|
55
|
+
| `Enter` | Toggle todo done/undone |
|
|
56
|
+
| `t` | Add new todo |
|
|
57
|
+
| `n` | Add new text line |
|
|
58
|
+
| `d` | Delete item at cursor |
|
|
59
|
+
| `s` | Save changes |
|
|
60
|
+
| `q` | Save and quit |
|
|
61
|
+
|
|
62
|
+
### Capture & Search
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
vertex capture "buy groceries" # Quick capture to Inbox
|
|
66
|
+
vertex search "keyword" # Full-text search
|
|
67
|
+
vertex search "#tag" # Search by tag
|
|
68
|
+
vertex search "type:todo status:open" # Open todos
|
|
69
|
+
vertex tags # List all tags
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Export
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
vertex export "Meeting Notes" # Print as markdown
|
|
76
|
+
vertex export "Meeting Notes" --json # Print as JSON
|
|
77
|
+
vertex export "Meeting Notes" -o out.md # Save to file
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Trash
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
vertex delete <title> # Move to trash
|
|
84
|
+
vertex restore <title> # Restore from trash
|
|
85
|
+
vertex trash # List trashed notes
|
|
86
|
+
vertex trash:empty # Permanently delete all
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Info
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
vertex status # Storage usage, note count
|
|
93
|
+
vertex help # Full help with all commands
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## Editor Syntax
|
|
97
|
+
|
|
98
|
+
When using `vertex edit`, you write in markdown:
|
|
99
|
+
|
|
100
|
+
```markdown
|
|
101
|
+
# Heading
|
|
102
|
+
**bold** *italic* `code` ~~strike~~
|
|
103
|
+
- Bullet list
|
|
104
|
+
1. Numbered list
|
|
105
|
+
- [x] Done task
|
|
106
|
+
- [ ] Open task
|
|
107
|
+
> Blockquote
|
|
108
|
+
[[Wiki Link]] #tagname
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Code blocks, math blocks (`$$ ... $$`), and standard markdown all work. Rich blocks (mermaid, callouts, file uploads) require the [web app](https://vertex-alu.pages.dev).
|
|
112
|
+
|
|
113
|
+
## Architecture
|
|
114
|
+
|
|
115
|
+
The CLI shares the same backend as the Vertex web app:
|
|
116
|
+
|
|
117
|
+
- **Database**: Supabase (PostgreSQL with RLS)
|
|
118
|
+
- **Auth**: Supabase Auth (GitHub, Google, Email)
|
|
119
|
+
- **Storage**: Cloudflare R2
|
|
120
|
+
|
|
121
|
+
Notes created in the CLI appear in the web app and vice versa.
|
|
122
|
+
|
|
123
|
+
## Requirements
|
|
124
|
+
|
|
125
|
+
- Node.js 18+
|
|
126
|
+
- A Vertex account (sign up via `vertex login`)
|
|
127
|
+
|
|
128
|
+
## License
|
|
129
|
+
|
|
130
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "vertex-notes",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Vertex — keyboard-first knowledge workspace CLI",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
7
7
|
"vertex": "./bin/run.js"
|
|
8
8
|
},
|
|
9
9
|
"main": "dist/index.js",
|
|
10
|
-
"files": ["bin", "dist"],
|
|
10
|
+
"files": ["bin", "dist", "README.md"],
|
|
11
11
|
"keywords": ["vertex", "notes", "cli", "knowledge", "todo", "markdown", "productivity"],
|
|
12
12
|
"author": "Sahil Kumar Sinha",
|
|
13
13
|
"license": "MIT",
|