@sift-wiki/cli 0.1.3 → 0.1.5

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.
Files changed (3) hide show
  1. package/README.md +52 -22
  2. package/dist/bin/sift.js +2069 -542
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,13 +1,21 @@
1
1
  # Sift CLI
2
2
 
3
- This repository is the public release mirror for `@sift-wiki/cli`.
4
-
5
- The package installs the `sift` command:
3
+ The intended public install path is npm:
6
4
 
7
5
  ```bash
8
6
  npm install -g @sift-wiki/cli
9
- sift login
10
- sift doctor
7
+ ```
8
+
9
+ The package is live on the public npm registry and installs the `sift` command.
10
+ This private monorepo owns CLI source and package verification. Public npm
11
+ publishes are cut from the `goodnight000/sift-cli` release mirror so provenance
12
+ can point at a public GitHub source repository.
13
+
14
+ Repo maintainers can verify package changes before promoting a release artifact
15
+ with:
16
+
17
+ ```bash
18
+ pnpm --filter @sift-wiki/cli pack:verify
11
19
  ```
12
20
 
13
21
  For one-off use without a global install:
@@ -17,26 +25,48 @@ npx -y @sift-wiki/cli@latest auth status --json
17
25
  npm exec --yes --package @sift-wiki/cli@latest -- sift auth status --json
18
26
  ```
19
27
 
20
- ## Release Shape
28
+ The CLI bundles its own agent setup skill. An agent can install it before any
29
+ other setup (this is the entry point of the local-agent onboarding prompt):
21
30
 
22
- The private Sift monorepo builds the bundled CLI artifact. This public repo
23
- contains only the files needed to publish the public npm package:
31
+ ```bash
32
+ npx -y @sift-wiki/cli@latest skill install # writes .claude/skills/sift-setup/SKILL.md
33
+ sift skill print sift-cli # or print it to stdout
34
+ sift skill list # list bundled skills
35
+ ```
24
36
 
25
- - `package.json`
26
- - `README.md`
27
- - `dist/bin/sift.js`
28
- - `scripts/verify-release.mjs`
29
- - `.github/workflows/publish-cli.yml`
37
+ `sift skill` commands are local and need no auth.
30
38
 
31
- The bundled `dist/bin/sift.js` is the same artifact npm users receive.
39
+ Then authenticate and check the installed command:
32
40
 
33
- ## Maintainer Release
41
+ ```bash
42
+ sift login
43
+ sift doctor
44
+ sift ask "what changed this week?"
45
+ ```
34
46
 
35
- 1. Update `package.json` and `dist/bin/sift.js`.
36
- 2. Run `npm run verify`.
37
- 3. Commit and push to `main`.
38
- 4. Tag `cli-v<package-version>`.
39
- 5. Push the tag.
47
+ The CLI is a hosted thin client. `sift login` is the normal setup path and opens
48
+ the existing browser login flow.
49
+
50
+ ## Roam Research import
51
+
52
+ Open the graph in Roam Desktop, then approve read-only local access:
53
+
54
+ ```bash
55
+ npx -y @roam-research/roam-mcp connect --access-level read-only
56
+ ```
57
+
58
+ Import only pages marked `[[Sift]]` in Roam:
59
+
60
+ ```bash
61
+ sift roam import --scope sift-tag
62
+ ```
63
+
64
+ Import the whole graph only when you intentionally want Sift to read every
65
+ readable page:
66
+
67
+ ```bash
68
+ sift roam import --scope whole-graph --confirm-whole-graph
69
+ ```
40
70
 
41
- The tag workflow publishes through npm trusted publishing. It uses GitHub OIDC
42
- and does not require an npm token secret.
71
+ For repo-local install details, troubleshooting, and advanced CI/headless
72
+ env-token auth, see `docs/cli/install.md`.