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