@klok-integration/cli 0.6.245 → 0.7.248
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 +1 -0
- package/assets/agents/AGENTS.workspace.md +12 -4
- package/assets/agents/skills/klok-cli/SKILL.md +57 -0
- package/assets/agents/skills/klok-cli/reference.md +1096 -0
- package/assets/agents/skills/klok-docs/SKILL.md +6 -1
- package/assets/agents/skills/klok-worktree/SKILL.md +2 -1
- package/dist/cli.js +7 -7
- package/package.json +1 -1
|
@@ -10,12 +10,16 @@ project exposes its whole content as a single markdown file, generated by znai (
|
|
|
10
10
|
serves it to a browser session and to a GitLab personal access token, which is what klok-cli sends:
|
|
11
11
|
|
|
12
12
|
```
|
|
13
|
+
klok docs list # the projects you may read: doc id, title, description
|
|
13
14
|
klok docs read <doc-id> # the markdown on stdout, one status line on stderr
|
|
14
15
|
klok docs read <doc-id> --json # {docId, url, source, status, etag, fetchedAt, bytes, content}
|
|
15
16
|
klok docs read <doc-id> --out x.md # to a file
|
|
16
17
|
klok docs id [tenant/group/.../repo] # the doc id of a repository, this one by default
|
|
17
18
|
```
|
|
18
19
|
|
|
20
|
+
`klok docs list` reads the portal's index, so it is where to find the doc id of a project you do not know yet. A
|
|
21
|
+
docs server without the index answers 404; derive the doc id with `klok docs id` instead.
|
|
22
|
+
|
|
19
23
|
Read it; it is the authoritative version of the repository's `klok-docs/` plus the generated route, datamodel and
|
|
20
24
|
configuration pages. Do not answer from memory when a page exists. The answer is cached under
|
|
21
25
|
`~/.cache/klok/docs/` with its ETag, so reading a page twice costs one conditional request; without network the
|
|
@@ -64,7 +68,8 @@ question is about what a project does.
|
|
|
64
68
|
|
|
65
69
|
1. Run `klok agents update --check` once at the start of the task; on exit 5 run `klok agents update`, so the
|
|
66
70
|
skills you read are the catalogs' current ones.
|
|
67
|
-
2. Identify the repositories involved and
|
|
71
|
+
2. Identify the repositories involved and find their doc ids: `klok docs list`, or `klok docs id <path>` for a
|
|
72
|
+
repository you know.
|
|
68
73
|
3. `klok docs read <doc-id>` for each. Handle 404, 401 and 403 as the table says.
|
|
69
74
|
4. Read the strategy documentation first when the task touches design or naming, and the *Onboarding a tenant*
|
|
70
75
|
runbook in `klok-framework-development-guide` when it touches onboarding; read the framework documentation
|
|
@@ -35,7 +35,8 @@ basename, never put the worktree inside `.claude`, inside the canonical checkout
|
|
|
35
35
|
work on. A worktree under `<root>/worktrees` does not sit below those directories, so no tool loads them for
|
|
36
36
|
you. Keep the existing project rules; this skill does not replace them.
|
|
37
37
|
3. **Inspect, do not touch.** `git -C <canonical> status --short`, `git -C <canonical> worktree list --porcelain`
|
|
38
|
-
and the canonical branch. Never `stash`, `reset`, `clean`, `checkout` or `switch` there
|
|
38
|
+
and the canonical branch. Never `stash`, `reset`, `clean`, `checkout` or `switch` there; the only update of a
|
|
39
|
+
canonical checkout is `klok sync pull`, which fast-forwards it or reports why it cannot. Uncommitted changes in
|
|
39
40
|
the canonical checkout are not a blocker; the worktree starts from committed history. If the task depends on
|
|
40
41
|
those changes, say so and ask for a handoff instead of moving them.
|
|
41
42
|
4. **Choose the base.** Fetch the remote and resolve its default branch from the remote HEAD
|