sumibako 0.2.0 → 0.2.2

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.
Files changed (3) hide show
  1. package/index.mjs +969 -911
  2. package/package.json +3 -3
  3. package/SKILL.md +0 -186
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sumibako",
3
- "version": "0.2.0",
3
+ "version": "0.2.2",
4
4
  "description": "File the plans, specs and notes your coding agent writes into your Sumibako vault, and get a shareable link back.",
5
5
  "type": "module",
6
6
  "bin": {
@@ -30,11 +30,11 @@
30
30
  "homepage": "https://sumibako.com",
31
31
  "repository": {
32
32
  "type": "git",
33
- "url": "git+https://github.com/PrashantShaw/Taskly.git",
33
+ "url": "git+https://github.com/sumibako/agents.git",
34
34
  "directory": "cli"
35
35
  },
36
36
  "bugs": {
37
- "url": "https://github.com/PrashantShaw/Taskly/issues"
37
+ "url": "https://github.com/sumibako/agents/issues"
38
38
  },
39
39
  "author": "Prashant Shaw",
40
40
  "license": "MIT",
package/SKILL.md DELETED
@@ -1,186 +0,0 @@
1
- ---
2
- name: sumibako
3
- description: File a plan, spec, ADR, handoff note or research report into the user's Sumibako vault and get back a link they can send to someone. Use when the user asks to save, file, publish or share a document you wrote, or asks for "a link to this", or says a teammate needs to read it. Also use to read, amend or take down a page already in the vault, and to search what is there before writing something new.
4
- license: MIT
5
- compatibility: Requires Node 18+ and network access to sumibako.com
6
- metadata:
7
- author: sumibako
8
- version: "0.2.0"
9
- ---
10
-
11
- # Filing documents in Sumibako
12
-
13
- Sumibako is the user's notes vault. This skill puts a Markdown document you
14
- wrote into it and, on request, gives you a public link to hand back.
15
-
16
- ## When to use this
17
-
18
- Reach for it when a document you produced needs to outlive the session or be
19
- read by somebody who is not in it:
20
-
21
- - The user says "save this", "file this", "put this in my notes", "publish
22
- this", "give me a link", "send this to my team", "I need to share this".
23
- - You finished a plan, spec, design, ADR, migration checklist, incident
24
- write-up, research summary or handoff note, and the user wants to keep it.
25
- - You are picking up work and want to know what is already written down:
26
- `sumibako search`, or `sumibako search` with no words to see the vault.
27
- - The user wants something already filed changed: a section added to a running
28
- log, a decision corrected, a page taken back off the web.
29
-
30
- Do **not** use it for things that belong in the repository. Code, tests,
31
- configuration and specs that are reviewed alongside a diff go in the repo and
32
- through a pull request. This is for the documents whose audience is a person,
33
- not a compiler, and often a person who will never open the repo.
34
-
35
- ## Connecting, the first time
36
-
37
- **There is no setup step to do in advance, and nothing for the user to paste.**
38
- Run the command you were going to run. If this machine is not connected yet,
39
- the command prints a link and stops with **exit code 3** without doing any
40
- work:
41
-
42
- ```
43
- Connect this machine to Sumibako:
44
- https://sumibako.com/connect?code=WXYZ-4821
45
-
46
- It should show the code WXYZ-4821. If it does not, the
47
- page belongs to a different request - close it.
48
-
49
- Then run the same command again.
50
- ```
51
-
52
- When you see exit code 3:
53
-
54
- 1. **Give the user the link exactly as printed**, along with the code, and ask
55
- them to open it and approve the request. Do not shorten it, do not describe
56
- it, do not put it behind other text.
57
- 2. **Do not wait, poll, or retry in a loop.** Finish your turn. Nothing is
58
- pending on your side.
59
- 3. **When the user says they have approved it, run the same command again.** It
60
- collects the token and carries on with the original job in one step. You do
61
- not need to run `login` separately.
62
-
63
- Nothing else about this is yours to handle:
64
-
65
- - **Never ask the user for a token**, and never offer to take one in chat. A
66
- token pasted into a conversation is a credential in a transcript.
67
- - **Never run `npx sumibako login` on your own.** It waits for a person, which
68
- is the one thing your shell cannot do. The flow above exists so you do not
69
- have to.
70
- - **Exit code 3 is not a failure.** It means "not connected yet". Any other
71
- non-zero code is a real error and worth reading.
72
-
73
- If the user would rather paste a token they already have, `npx sumibako login
74
- --token <token>` takes one, and CI sets `SUMIBAKO_TOKEN` in the environment and
75
- skips all of this.
76
-
77
- ## Filing a document
78
-
79
- Write the Markdown to a file first, then publish the file. Do not pipe a
80
- document through the command line.
81
-
82
- ```bash
83
- npx sumibako publish docs/plans/auth-rewrite.md
84
- ```
85
-
86
- To get a link the user can send to someone:
87
-
88
- ```bash
89
- npx sumibako publish docs/plans/auth-rewrite.md --public
90
- ```
91
-
92
- The command prints the page's link, and the public link when there is one.
93
- Give the user the public link verbatim. Do not paraphrase or shorten it.
94
-
95
- ## The one rule that matters
96
-
97
- **A file is filed under its path in the repository, so publishing the same file
98
- again updates the same page.** Run it after every revision. You will not create
99
- duplicates, and the user's link keeps working and keeps showing the current
100
- version.
101
-
102
- Only pass `--new` when the user genuinely wants a second, separate page - a new
103
- incident, a different feature. Reaching for it out of caution is how a vault
104
- fills up with eleven copies of one plan.
105
-
106
- ## Changing a page instead of replacing it
107
-
108
- `publish` replaces the whole page, which is right when you still hold the file.
109
- When you do not - the page was written in the app, or in a session that has
110
- ended - read it and change the part that is wrong:
111
-
112
- ```bash
113
- npx sumibako open docs/plans/auth.md --markdown # the page, as Markdown
114
- ```
115
-
116
- That Markdown is the page. Add to it, or replace an exact piece of it:
117
-
118
- ```bash
119
- # add a line to the end, without sending the rest back
120
- npx sumibako append docs/decisions.md "- 2026-09-06: chose Postgres over Dynamo"
121
-
122
- # correct one sentence
123
- npx sumibako edit docs/plans/auth.md \
124
- --find "We will ship this in Q3." \
125
- --replace "We will ship this in Q4, after the migration."
126
-
127
- # rename
128
- npx sumibako edit docs/plans/auth.md --title "Auth rewrite, revised"
129
- ```
130
-
131
- **`--find` must match exactly once.** It is matched against the Markdown that
132
- `open --markdown` prints, not against the words as they look in the app, so
133
- read the page first and paste from what you read. If it appears twice the
134
- command refuses rather than guessing - quote more of the surrounding lines and
135
- try again. Do not work around this by replacing the whole page unless the user
136
- asked for a rewrite.
137
-
138
- Prefer `append` over reading and re-publishing a page you are only adding to.
139
- It sends one line instead of the whole document and cannot disturb the rest.
140
-
141
- ## The rest of the commands
142
-
143
- ```bash
144
- npx sumibako search "auth rewrite" # what is already written down
145
- npx sumibako search # or list the newest pages
146
- npx sumibako open docs/plans/auth.md # the links for a page
147
- npx sumibako open docs/plans/auth.md --markdown # and the page itself
148
- npx sumibako unpublish docs/plans/auth.md # take the link off the web
149
- ```
150
-
151
- ## Writing for it
152
-
153
- The document is rendered as a real page, so ordinary Markdown pays off:
154
-
155
- - **The first heading becomes the page title.** Start with one `#` line saying
156
- what the document is. Or put `title:` in YAML frontmatter.
157
- - Headings, lists, task lists, tables, blockquotes, links and fenced code all
158
- render properly. Tables are worth using for options and trade-offs.
159
- - Code fences keep their language and get syntax highlighting.
160
- - `> [!NOTE]` and `> [!WARNING]` become a bold label on the quote.
161
-
162
- Two things degrade, and the command tells you when they do:
163
-
164
- - **Mermaid diagrams** render as plain code, not pictures. A short prose
165
- description alongside the diagram is worth adding.
166
- - **Raw HTML** is kept as text.
167
-
168
- ## What it will not do
169
-
170
- - It cannot delete a page. The user does that in the app. `unpublish` takes the
171
- link off the web and leaves the writing alone.
172
- - It cannot make a page findable by search engines. Published pages carry
173
- `noindex`; the user turns that on themselves if they want it, per page.
174
- - It cannot read or write anyone else's vault.
175
-
176
- ## Errors worth reading
177
-
178
- - `400` - the request was wrong, and the message says how. From an edit this
179
- is usually a `--find` that matched nothing or matched twice. Read the page
180
- with `open --markdown` and quote it exactly.
181
- - `401` - the token was revoked. The CLI forgets it, so running the same
182
- command again starts a fresh connect and prints a link. Relay that link.
183
- - `403` - the token is not allowed to publish. The user can create one that is.
184
- - `409` - the plan's page limit is reached. Report the message; it says which.
185
- - `413` - the document is too long. Split it.
186
- - `429` - too many requests. Wait the number of seconds it names.