bikeshed-now 0.4.0 → 0.4.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 +14 -11
- package/package.json +1 -1
- package/src/client.mjs +1 -1
package/README.md
CHANGED
|
@@ -3,24 +3,26 @@
|
|
|
3
3
|
Publish a document to a [Bikeshed](https://bikeshed.now) deployment, then read
|
|
4
4
|
the comments people left on it — each one with the exact sentence it is about.
|
|
5
5
|
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
6
|
+
It talks to [bikeshed.now](https://bikeshed.now) over HTTPS, with a personal
|
|
7
|
+
access token that carries exactly your own permissions. Bikeshed is also
|
|
8
|
+
self-hostable: point the client at your own deployment and everything below
|
|
9
|
+
works the same, with your address in place of `https://bikeshed.now`.
|
|
9
10
|
|
|
10
11
|
```bash
|
|
11
12
|
npm i -g bikeshed-now
|
|
12
13
|
bikeshed login # asks for the deployment and a token
|
|
13
14
|
```
|
|
14
15
|
|
|
15
|
-
Create a token
|
|
16
|
-
It is shown once. `BIKESHED_ORIGIN` and `BIKESHED_TOKEN` work
|
|
17
|
-
`login` where an interactive command cannot run — a CI job, or an
|
|
16
|
+
Create a token at [bikeshed.now/account](https://bikeshed.now/account) — choose
|
|
17
|
+
**Command line**. It is shown once. `BIKESHED_ORIGIN` and `BIKESHED_TOKEN` work
|
|
18
|
+
instead of `login` where an interactive command cannot run — a CI job, or an
|
|
19
|
+
agent.
|
|
18
20
|
|
|
19
21
|
## The loop
|
|
20
22
|
|
|
21
23
|
```bash
|
|
22
24
|
bikeshed publish proposal.md --title "Storage migration"
|
|
23
|
-
# published storage-migration v1 — https
|
|
25
|
+
# published storage-migration v1 — https://bikeshed.now/d/storage-migration
|
|
24
26
|
|
|
25
27
|
# Somebody highlights a sentence and says what is wrong with it.
|
|
26
28
|
bikeshed comments storage-migration
|
|
@@ -42,7 +44,7 @@ The address comes from the title. To choose it, pass `--id`:
|
|
|
42
44
|
|
|
43
45
|
```bash
|
|
44
46
|
bikeshed publish platform.md --id 01-platform
|
|
45
|
-
# published 01-platform v1 — https
|
|
47
|
+
# published 01-platform v1 — https://bikeshed.now/d/01-platform
|
|
46
48
|
```
|
|
47
49
|
|
|
48
50
|
If the id is taken, the document is still published, at the id plus a few
|
|
@@ -53,7 +55,7 @@ unlisted document you are not a member of needs the link, because its key is in
|
|
|
53
55
|
it; without the key the document answers as an id that does not exist.
|
|
54
56
|
|
|
55
57
|
```bash
|
|
56
|
-
bikeshed comments 'https
|
|
58
|
+
bikeshed comments 'https://bikeshed.now/d/build-estimate?k=…'
|
|
57
59
|
```
|
|
58
60
|
|
|
59
61
|
`bikeshed --help` lists the rest — listing documents, folders, and installing the
|
|
@@ -66,8 +68,9 @@ expiry. Those are decisions a person makes in the interface, deliberately.
|
|
|
66
68
|
|
|
67
69
|
## For agents
|
|
68
70
|
|
|
69
|
-
A deployment serves its own instructions at
|
|
70
|
-
|
|
71
|
+
A deployment serves its own instructions at
|
|
72
|
+
[`https://bikeshed.now/llms.txt`](https://bikeshed.now/llms.txt), and the skills
|
|
73
|
+
behind them at `/skills/index.json`. `bikeshed skills install <dir>`
|
|
71
74
|
writes them where your harness reads skills from.
|
|
72
75
|
|
|
73
76
|
Everything done with a token is stamped with the channel it came through, so a
|
package/package.json
CHANGED
package/src/client.mjs
CHANGED