yarkr-cli 1.0.0 → 1.0.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 +43 -12
- package/dist/yarkr.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,29 +4,60 @@ Install skills, agents and MCP toolsets from [Yarkr](https://yarkr.com) into the
|
|
|
4
4
|
Claude Code, Codex, opencode, Cursor and more.
|
|
5
5
|
|
|
6
6
|
```sh
|
|
7
|
-
|
|
8
|
-
|
|
7
|
+
npm install -g yarkr-cli # Node 22 or newer; or run any command with `npx yarkr-cli …`
|
|
8
|
+
yarkr add posterus-ltd/code-review-checklist # a public package, no account needed
|
|
9
|
+
yarkr add posterus-ltd/github --harness codex # pick the harnesses to write
|
|
9
10
|
```
|
|
10
11
|
|
|
11
|
-
|
|
12
|
+
## Sync an ark to your machine
|
|
13
|
+
|
|
14
|
+
An ark is a curated set of skills, agents and toolsets hosted in the registry. `yarkr sync` writes each one into the
|
|
15
|
+
harness's own layout (`~/.claude/skills/…`, `~/.agents/…`, MCP configs and so on):
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
yarkr arks # list public arks
|
|
19
|
+
yarkr sync acme/starter # install one into your home directory
|
|
20
|
+
yarkr sync acme/starter --harness claude-code # only write Claude Code's files
|
|
21
|
+
yarkr ark # what your arks give you, and which version
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Signed in, a bare `yarkr sync` installs every ark you're a member of, plus your personal ark. Run it again to pick up
|
|
25
|
+
whatever an admin added or removed; `yarkr sync --check` exits 1 when you're behind.
|
|
26
|
+
|
|
27
|
+
## Set up an existing repo
|
|
28
|
+
|
|
29
|
+
In a project, `yarkr init` creates `yarkr.json` (and `.yarkrrc`), detecting the harnesses already used there.
|
|
30
|
+
`yarkr add` and `yarkr sync` then pin every package in `yarkr.lock`, so teammates and CI get the same releases:
|
|
12
31
|
|
|
13
32
|
```sh
|
|
14
|
-
|
|
15
|
-
yarkr init
|
|
33
|
+
cd my-repo
|
|
34
|
+
yarkr init --ark acme/engineering # optional: install a team's ark into this project
|
|
16
35
|
yarkr add posterus-ltd/playwright-test-authoring
|
|
17
|
-
|
|
36
|
+
git add yarkr.json yarkr.lock .yarkrrc .claude AGENTS.md && git commit
|
|
37
|
+
yarkr sync --check # in CI: exit 1 when anything is out of date
|
|
18
38
|
```
|
|
19
39
|
|
|
20
|
-
|
|
21
|
-
(a skill that's a single markdown file, or a folder with a README instead of
|
|
22
|
-
at the root, and nothing has to move:
|
|
40
|
+
To publish from the repo instead, there's nothing to init: Yarkr finds `SKILL.md` folders, `agents/*.md` and
|
|
41
|
+
`.mcp.json` on its own. Anything else (a skill that's a single markdown file, or a folder with a README instead of
|
|
42
|
+
SKILL.md) goes in one `yarkr.index.yaml` at the root, and nothing has to move. Lint it before you push:
|
|
23
43
|
|
|
24
44
|
```sh
|
|
45
|
+
yarkr lint # what will be published, and what the hub would refuse
|
|
46
|
+
yarkr lint --strict # in CI: fail on warnings too
|
|
25
47
|
yarkr guide index-repo -o ~/.claude/skills/index-repo/ # a skill your agent uses to write the index
|
|
26
|
-
yarkr lint # what will be published, and what's wrong
|
|
27
48
|
```
|
|
28
49
|
|
|
29
|
-
|
|
30
|
-
|
|
50
|
+
## Sign in for private packages
|
|
51
|
+
|
|
52
|
+
Public packages and public arks work signed out. Your org's private packages and arks need a token:
|
|
53
|
+
|
|
54
|
+
```sh
|
|
55
|
+
yarkr login # signs in in the browser; the token goes to your keychain (or ~/.yarkrrc)
|
|
56
|
+
yarkr login --no-browser # over SSH: open the printed link anywhere, then paste the token
|
|
57
|
+
yarkr whoami # check who you're signed in as
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
In CI, store a read-only token as a secret and set `YARKR_TOKEN`. `yarkr` uses the public hub at `https://yarkr.com`
|
|
61
|
+
unless you point it at your own instance with `yarkr login --registry <url>`.
|
|
31
62
|
|
|
32
63
|
Docs: [docs/cli.md](https://github.com/posterus-ltd/yarkr-public/blob/main/docs/cli.md) · Source: [github.com/posterus-ltd/yarkr-public](https://github.com/posterus-ltd/yarkr-public) · MIT
|
package/dist/yarkr.js
CHANGED
|
@@ -45039,7 +45039,7 @@ async function repoLint(dir, opts) {
|
|
|
45039
45039
|
}
|
|
45040
45040
|
|
|
45041
45041
|
// src/index.ts
|
|
45042
|
-
var VERSION = true ? "1.0.
|
|
45042
|
+
var VERSION = true ? "1.0.1" : "0.0.0-dev";
|
|
45043
45043
|
var act = (fn) => async (...a) => {
|
|
45044
45044
|
await fn(...a);
|
|
45045
45045
|
};
|
package/package.json
CHANGED