@etiquekit/etq 1.0.5 → 1.0.7
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/AGENTS.md +26 -17
- package/QuickStart.md +11 -3
- package/README.md +13 -13
- package/bin/etiquette +293 -292
- package/docs/README.md +0 -1
- package/docs/RELEASE_SURFACE_AUDIT.md +0 -1
- package/package.json +9 -2
- package/templates/seat-packs-v0/README.md +1 -1
- package/templates/seat-packs-v0/source/claude-code-seat/README.md +1 -1
- package/templates/seat-packs-v0/source/codex-seat/README.md +1 -1
- package/templates/seat-packs-v0/source/gemini-seat/README.md +1 -1
- package/templates/seat-packs-v0/source/ollama-seat/README.md +1 -1
- package/templates/seat-packs-v0/source/openrouter-seat/README.md +1 -1
- package/docs/CONCEPT_STATUS.md +0 -67
package/AGENTS.md
CHANGED
|
@@ -1,28 +1,37 @@
|
|
|
1
1
|
# Etiquette Agent Guide
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
## If you installed this package
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
You are reading the INSTALLED copy of the Etiquette CLI (npm or tarball) —
|
|
6
|
+
"this repo" below refers to Etiquette's source repository, not your project.
|
|
7
|
+
As an agent working in a project governed by Etiquette:
|
|
6
8
|
|
|
7
|
-
|
|
9
|
+
1. Read [README.md](README.md), then [QuickStart.md](QuickStart.md).
|
|
10
|
+
2. Orient with `etq whereami`; join your assigned seat; read the task
|
|
11
|
+
envelope and the project's `docs/work/runbooks/WORKING_DISCIPLINE.md`.
|
|
12
|
+
3. Respect allowed writes, run the named validation, write the receipt at
|
|
13
|
+
the path `pickup` names, post it, and pass `etq return check` before
|
|
14
|
+
claiming completion.
|
|
8
15
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
3. [templates/etiquette-vanilla-v0/README.md](templates/etiquette-vanilla-v0/README.md)
|
|
12
|
-
|
|
13
|
-
Do not send new seats through internal history, old coordination lanes, or maintainer-only notes.
|
|
16
|
+
Commands record evidence; they never grant, merge, close, publish, or
|
|
17
|
+
promote.
|
|
14
18
|
|
|
15
|
-
##
|
|
19
|
+
## If you are working on the Etiquette source repo
|
|
16
20
|
|
|
17
|
-
|
|
21
|
+
Keep the all-developer onboarding path small. New engineers start with:
|
|
18
22
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
-
|
|
22
|
-
- validation scripts for release hygiene.
|
|
23
|
+
1. [README.md](README.md)
|
|
24
|
+
2. [docs/SEAT_PROVISIONING.md](docs/SEAT_PROVISIONING.md)
|
|
25
|
+
3. [templates/etiquette-vanilla-v0/README.md](templates/etiquette-vanilla-v0/README.md)
|
|
23
26
|
|
|
24
|
-
|
|
27
|
+
Do not send new seats through internal history, old coordination lanes, or
|
|
28
|
+
maintainer-only notes.
|
|
25
29
|
|
|
26
|
-
|
|
30
|
+
This repo owns: the minimal vanilla seat scaffold; optional runtime seat-pack
|
|
31
|
+
scaffolds; shared task, readiness, and receipt contracts; validation scripts
|
|
32
|
+
for release hygiene. It does not own product repos, product lane state,
|
|
33
|
+
secrets, hosted services, or runtime vendor setup.
|
|
27
34
|
|
|
28
|
-
Release-facing docs must stay role-based and portable. Do not introduce
|
|
35
|
+
Release-facing docs must stay role-based and portable. Do not introduce
|
|
36
|
+
person names, local machine paths, historical bus references, or
|
|
37
|
+
project-specific lane IDs into the default onboarding surface.
|
package/QuickStart.md
CHANGED
|
@@ -29,12 +29,16 @@ export PATH="$HOME/.etiquette/bin:$PATH"
|
|
|
29
29
|
|
|
30
30
|
From the project repo:
|
|
31
31
|
|
|
32
|
+
Same core order as the README quickstart; `handoff`/`whereami` are optional
|
|
33
|
+
orientation verbs. `bootstrap local` does not replace `init`.
|
|
34
|
+
|
|
32
35
|
```sh
|
|
36
|
+
etq init --project "$PWD"
|
|
37
|
+
etq doctor --project "$PWD"
|
|
38
|
+
etq bootstrap local --project "$PWD" --profile codex-cc-gemini --task-prefix APP
|
|
33
39
|
etq setup --target auto --project "$PWD"
|
|
34
40
|
etq handoff --project "$PWD" --profile codex-cc-gemini --task-prefix APP
|
|
35
|
-
etq bootstrap local --project "$PWD" --profile codex-cc-gemini --task-prefix APP
|
|
36
41
|
etq whereami --project "$PWD" --seat codex-seat --task APP-001
|
|
37
|
-
etq doctor --project "$PWD"
|
|
38
42
|
etq join --project "$PWD" --seat codex-seat
|
|
39
43
|
etq pickup --project "$PWD" --seat codex-seat --task APP-001 --allow-current-project --text
|
|
40
44
|
etq console board --project "$PWD" --text
|
|
@@ -60,7 +64,11 @@ envelope, and runbook. For branch hygiene, read [docs/WORKTREE_QOL.md](docs/WORK
|
|
|
60
64
|
|
|
61
65
|
## 4. Check And Record Evidence
|
|
62
66
|
|
|
63
|
-
|
|
67
|
+
Completion gate: write the receipt at the path `pickup` names, post it
|
|
68
|
+
(`etq post --role implementation-return --lane <task> --from <seat> --to <seat>`),
|
|
69
|
+
then `etq return check`. Separately, `dispatch check` gates ROUTING before
|
|
70
|
+
work begins — create checkable dispatch examples, then run the generated
|
|
71
|
+
command:
|
|
64
72
|
|
|
65
73
|
```sh
|
|
66
74
|
etq dispatch scaffold --project "$PWD" --task-id APP-001 --seat codex-seat
|
package/README.md
CHANGED
|
@@ -20,7 +20,7 @@ curl -fsSL https://etiquekit.com/install.sh | sh # or: native installer
|
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
Requires `bun >= 1.3` and `git >= 2.40`. macOS and Linux. The installer
|
|
23
|
-
verifies signatures against a pinned
|
|
23
|
+
verifies signatures against a pinned key before executing.
|
|
24
24
|
|
|
25
25
|
## Sixty seconds to a governed workspace
|
|
26
26
|
|
|
@@ -30,21 +30,24 @@ etq doctor --project . # readiness — green before work
|
|
|
30
30
|
etq bootstrap local --project . \
|
|
31
31
|
--profile codex-cc-gemini --task-prefix APP
|
|
32
32
|
etq setup --target auto --project . # register your agent CLI (explicit)
|
|
33
|
-
etq join --seat
|
|
33
|
+
etq join --seat codex-seat --project . # profile seats: codex/cc/gemini/manager
|
|
34
34
|
etq console board --project . --text # the live task board
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
Per-runtime seat packs: `provision-seat claude-code` · `provision-seat codex`
|
|
38
38
|
· `provision-seat gemini` · `provision-seat ollama` · `provision-seat openrouter`.
|
|
39
39
|
|
|
40
|
-
The daily loop
|
|
40
|
+
The daily loop:
|
|
41
41
|
|
|
42
42
|
```sh
|
|
43
|
-
etq pickup --seat
|
|
44
|
-
# ... do the work
|
|
45
|
-
etq
|
|
43
|
+
etq pickup --seat codex-seat --task APP-001 --expect-project-id <id> --text
|
|
44
|
+
# ... do the work; write the receipt at the path pickup names ...
|
|
45
|
+
etq post --role implementation-return --lane APP-001 \
|
|
46
|
+
--from codex-seat --to manager-seat --project .
|
|
47
|
+
etq return check --task APP-001 --seat codex-seat # the completion gate
|
|
46
48
|
```
|
|
47
49
|
|
|
50
|
+
(`dispatch check` gates routing BEFORE work; `return check` gates completion.)
|
|
48
51
|
Every step appends to the workspace journal — an append-only event log inside
|
|
49
52
|
your repo. Nothing leaves your machine: no backend, no telemetry, no account.
|
|
50
53
|
|
|
@@ -58,15 +61,13 @@ your repo. Nothing leaves your machine: no backend, no telemetry, no account.
|
|
|
58
61
|
| Receipt | What proves the work happened? |
|
|
59
62
|
| Promotion gate | Where does candidate work become accepted truth? |
|
|
60
63
|
|
|
61
|
-
Commands
|
|
62
|
-
|
|
63
|
-
Execution returns evidence; it never mints authority.
|
|
64
|
+
Commands initialize, check, record evidence, and project read models. They
|
|
65
|
+
**never** grant, merge, close, publish, or promote — evidence, not authority.
|
|
64
66
|
|
|
65
67
|
## Verify releases
|
|
66
68
|
|
|
67
|
-
The
|
|
68
|
-
|
|
69
|
-
key:
|
|
69
|
+
The signing key's SHA-256 fingerprint — cross-check against the copy at
|
|
70
|
+
https://etiquekit.com/docs/ before trusting a downloaded key:
|
|
70
71
|
|
|
71
72
|
```
|
|
72
73
|
917fbced1d6a82897ec3441a1d12947803ca4d42a6bc63d3412dee8bf8c3ce31
|
|
@@ -76,5 +77,4 @@ Then `openssl dgst -sha256 -verify <key> -signature SHA256SUMS.sig SHA256SUMS`
|
|
|
76
77
|
and `shasum -a 256 -c SHA256SUMS`. If any step fails: stop, do not install.
|
|
77
78
|
|
|
78
79
|
## License
|
|
79
|
-
|
|
80
80
|
Proprietary; distributed as compiled bundles for convenience.
|