sumibako 0.2.0 → 0.2.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/SKILL.md +50 -1
- package/package.json +3 -3
package/SKILL.md
CHANGED
|
@@ -3,11 +3,23 @@ name: sumibako
|
|
|
3
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
4
|
license: MIT
|
|
5
5
|
compatibility: Requires Node 18+ and network access to sumibako.com
|
|
6
|
+
allowed-tools: Bash(npx sumibako search:*) Bash(npx sumibako open:*) Bash(npx sumibako whoami)
|
|
6
7
|
metadata:
|
|
7
8
|
author: sumibako
|
|
8
|
-
version: "0.2.
|
|
9
|
+
version: "0.2.1"
|
|
9
10
|
---
|
|
10
11
|
|
|
12
|
+
<!--
|
|
13
|
+
`allowed-tools` covers the three commands that only read.
|
|
14
|
+
|
|
15
|
+
Deliberately not `publish`, `edit`, `append` or `unpublish`. Publishing puts a
|
|
16
|
+
document on the open web and the rest change what is in somebody's vault, and
|
|
17
|
+
a skill that pre-approved those would be using this field to talk its way past
|
|
18
|
+
the confirmation a person actually wants. Looking things up is the part where
|
|
19
|
+
a prompt is pure friction, so that is the part this covers.
|
|
20
|
+
-->
|
|
21
|
+
|
|
22
|
+
|
|
11
23
|
# Filing documents in Sumibako
|
|
12
24
|
|
|
13
25
|
Sumibako is the user's notes vault. This skill puts a Markdown document you
|
|
@@ -92,6 +104,43 @@ npx sumibako publish docs/plans/auth-rewrite.md --public
|
|
|
92
104
|
The command prints the page's link, and the public link when there is one.
|
|
93
105
|
Give the user the public link verbatim. Do not paraphrase or shorten it.
|
|
94
106
|
|
|
107
|
+
### Before you pass `--public`
|
|
108
|
+
|
|
109
|
+
`--public` puts the document on the open web. Anyone with the link can read it
|
|
110
|
+
without signing in. It is not indexed by search engines, and that is the only
|
|
111
|
+
protection it has.
|
|
112
|
+
|
|
113
|
+
So do two things first, both briefly:
|
|
114
|
+
|
|
115
|
+
1. **Read what you are about to publish** and check it carries no credentials,
|
|
116
|
+
customer data or anything else that should not leave the repository. If you
|
|
117
|
+
find something, say so and stop; do not publish it and ask afterwards.
|
|
118
|
+
2. **Say in one line what will become readable**, then publish.
|
|
119
|
+
|
|
120
|
+
Keep this to a sentence. It is a check, not a report - narrating the audit at
|
|
121
|
+
length is worse than not doing it, because the user stops reading and the one
|
|
122
|
+
time it matters gets skipped with everything else.
|
|
123
|
+
|
|
124
|
+
If you are unsure whether the user wants it on the web, publish privately
|
|
125
|
+
first. `publish` without `--public` files the page and nothing leaves the
|
|
126
|
+
account, and `--public` afterwards is one more command.
|
|
127
|
+
|
|
128
|
+
### The permission prompt is not an error
|
|
129
|
+
|
|
130
|
+
Publishing reaches the internet, so an agent harness may well stop and ask the
|
|
131
|
+
user before the command runs. That is the harness doing its job, and it happens
|
|
132
|
+
before Sumibako sees anything.
|
|
133
|
+
|
|
134
|
+
When it happens:
|
|
135
|
+
|
|
136
|
+
- **Do not retry the command in a loop**, and do not reach for a different tool.
|
|
137
|
+
Nothing failed.
|
|
138
|
+
- **Do not tell the user that publishing was blocked or that something went
|
|
139
|
+
wrong.** Tell them the command is waiting for their approval, and what it will
|
|
140
|
+
publish.
|
|
141
|
+
- If they approve, run it once. If they decline, leave it and say the document
|
|
142
|
+
is still local.
|
|
143
|
+
|
|
95
144
|
## The one rule that matters
|
|
96
145
|
|
|
97
146
|
**A file is filed under its path in the repository, so publishing the same file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "sumibako",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
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/
|
|
33
|
+
"url": "git+https://github.com/sumibako/agents.git",
|
|
34
34
|
"directory": "cli"
|
|
35
35
|
},
|
|
36
36
|
"bugs": {
|
|
37
|
-
"url": "https://github.com/
|
|
37
|
+
"url": "https://github.com/sumibako/agents/issues"
|
|
38
38
|
},
|
|
39
39
|
"author": "Prashant Shaw",
|
|
40
40
|
"license": "MIT",
|